vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Update API doc

pull/5339/head
GitHub Actions Bot 2024-02-23 08:39:54 +00:00
parent 8f0d3188cd
commit 07dca07016
2 changed files with 40 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/lib/ts-helpers.d.ts vendored
View File

@ -37,4 +37,4 @@ export declare type PassThrough<T = void> = T | object | undefined;
export declare type DefaultPassThrough<T = void> = T | ((instance?: VNode) => T | undefined) | undefined;
export declare type HintedString<T extends string> = (string & {}) | T;
export declare type HintedString<T extends string> = (string & {}) | T;

75
doc/common/apidoc/index.json
View File

@ -3685,7 +3685,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached.\nSpecial keywords are 'body' for document body and 'self' for the element itself."
},
@ -4935,7 +4935,7 @@
"name": "severity",
"optional": true,
"readonly": false,
"type": "null | string",
"type": "null | HintedString<\"success\" | \"secondary\" | \"info\" | \"warning\" | \"danger\" | \"contrast\">",
"default": "",
"description": "Severity type of the badge."
},
@ -6716,7 +6716,7 @@
"name": "badgeSeverity",
"optional": true,
"readonly": false,
"type": "null | string",
"type": "null | HintedString<\"success\" | \"secondary\" | \"info\" | \"warning\" | \"danger\" | \"contrast\">",
"default": "",
"description": "Severity type of the badge."
},
@ -6748,7 +6748,7 @@
"name": "severity",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"success\" | \"help\" | \"secondary\" | \"info\" | \"warning\" | \"danger\" | \"contrast\">",
"default": "",
"description": "Defines the style of the button."
},
@ -8436,7 +8436,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -10493,7 +10493,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself."
},
@ -12947,7 +12947,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself."
},
@ -17922,7 +17922,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -18346,7 +18346,7 @@
"name": "matchMode",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Filter match mode"
}
@ -18517,7 +18517,7 @@
"name": "filterMatchModes",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Match modes per field"
}
@ -18589,7 +18589,7 @@
"name": "filterMatchModes",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Match modes per field"
},
@ -18677,7 +18677,7 @@
"name": "filterMatchModes",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Match modes per field"
},
@ -20343,7 +20343,7 @@
"name": "scrollHeight",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"flex\">",
"default": "",
"description": "Height of the scroll viewport in fixed pixels or the 'flex' keyword for a dynamic size."
},
@ -22769,7 +22769,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the dialog gets attached."
},
@ -24406,7 +24406,7 @@
"name": "filterMatchMode",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"endsWith\" | \"startsWith\" | \"contains\">",
"default": "contains",
"description": "Defines the filtering algorithm to use when searching the options."
},
@ -24551,7 +24551,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -29715,7 +29715,7 @@
"name": "severity",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"error\" | \"success\" | \"secondary\" | \"info\" | \"contrast\" | \"warn\">",
"default": "info",
"description": "Severity level of the message."
},
@ -34043,7 +34043,7 @@
"name": "filterMatchMode",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"endsWith\" | \"startsWith\" | \"contains\">",
"default": "contains",
"description": "Defines the filtering algorithm to use when searching the options."
},
@ -35512,7 +35512,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -36725,7 +36725,7 @@
"name": "severity",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"error\" | \"success\" | \"secondary\" | \"info\" | \"contrast\" | \"warn\">",
"default": "info",
"description": "Severity level of the message."
},
@ -38114,7 +38114,7 @@
"name": "filterMatchMode",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"endsWith\" | \"startsWith\" | \"contains\">",
"default": "contains",
"description": "Defines the filtering algorithm to use when searching the options."
},
@ -38130,7 +38130,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself."
},
@ -40369,7 +40369,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -42744,7 +42744,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -49238,7 +49238,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached.\nSpecial keywords are 'body' for document body and 'self' for the element itself."
},
@ -49295,7 +49295,7 @@
"name": "severity",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"success\" | \"help\" | \"secondary\" | \"info\" | \"warning\" | \"danger\" | \"contrast\">",
"default": "",
"description": "Defines the style of the button."
},
@ -51381,7 +51381,7 @@
"name": "selector",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"@next\" | \"@prev\" | \"@parent\" | \"@grandparent\">",
"default": "",
"description": "Selector to define the target element. Available selectors are '@next', '@prev', '@parent' and '@grandparent'."
},
@ -53072,7 +53072,7 @@
"name": "severity",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"success\" | \"secondary\" | \"info\" | \"warning\" | \"danger\" | \"contrast\">",
"default": "",
"description": "Severity type of the tag."
},
@ -54283,7 +54283,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -57199,7 +57199,7 @@
"name": "scrollHeight",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"flex\">",
"default": "",
"description": "Height of the scroll viewport in fixed units or the 'flex' keyword for a dynamic size."
},
@ -57974,7 +57974,7 @@
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "string | HTMLElement",
"type": "HTMLElement | HintedString<\"body\" | \"self\">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
@ -58476,7 +58476,7 @@
"name": "matchMode",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Filter match mode"
}
@ -58583,7 +58583,7 @@
"name": "filterMatchModes",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Match modes per field"
}
@ -58655,7 +58655,7 @@
"name": "filterMatchModes",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Match modes per field"
},
@ -58743,7 +58743,7 @@
"name": "filterMatchModes",
"optional": false,
"readonly": false,
"type": "undefined | string",
"type": "undefined | HintedString<\"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\">",
"default": "",
"description": "Match modes per field"
},
@ -59435,7 +59435,7 @@
"name": "scrollHeight",
"optional": true,
"readonly": false,
"type": "string",
"type": "HintedString<\"flex\">",
"default": "",
"description": "Height of the scroll viewport in fixed pixels or the 'flex' keyword for a dynamic size."
},
@ -60417,6 +60417,9 @@
},
"DefaultPassThrough": {
"values": "T | (instance: VNode) => undefined | undefined"
},
"HintedString": {
"values": "string & Object | T"
}
}
}