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

Update API doc

pull/3938/head
GitHub Actions Bot 2023-05-05 09:37:15 +00:00
parent 38a8f2c3e7
commit 8285192303
1 changed files with 152 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8293,6 +8293,27 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ChipsPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "ChipsProps",
"default": ""
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "ChipsState",
"default": ""
}
],
"methods": []
},
"ChipsAddEvent": {
"description": "Custom add event.",
"relatedProp": "ChipsEmits.add",
@ -8341,6 +8362,121 @@
"methods": [],
"extendedTypes": "ChipsAddEvent"
},
"ChipsPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "ChipsProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "container",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the container's DOM element."
},
{
"name": "token",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the token's DOM element."
},
{
"name": "label",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the label's DOM element."
},
{
"name": "removeTokenIcon",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the remove token icon's DOM element."
},
{
"name": "inputToken",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the input token's DOM element."
},
{
"name": "input",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the input's DOM element."
}
],
"methods": []
},
"ChipsPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"ChipsState": {
"description": "Defines current inline state in Chips component.",
"relatedProp": "",
"props": [
{
"name": "id",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current id state as a string."
},
{
"name": "inputValue",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current input value as a string."
},
{
"name": "focused",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current focused state as a boolean."
},
{
"name": "focusedIndex",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Current focused item index state as a number."
}
],
"methods": []
},
"ChipsProps": {
"description": "Defines valid properties in Chips component.",
"relatedProp": "",
@ -8458,6 +8594,14 @@
"type": "string",
"default": "",
"description": "Establishes a string value that labels the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
}
],
"methods": []
@ -8542,6 +8686,14 @@
]
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"ChipsPassThroughOptionType": {
"values": "ChipsPassThroughAttributes | (options: ChipsPassThroughMethodOptions) => ChipsPassThroughAttributes | null | undefined"
}
}
}
},
"colorpicker": {