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

Update API doc

pull/3913/head
GitHub Actions Bot 2023-04-26 10:49:55 +00:00
parent 2088f2913a
commit 96dbee1bc3
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

@ -12906,6 +12906,142 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.", "methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.", "typeDescription": "Defines the custom types used by the module.",
"values": { "values": {
"DockPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "DockProps",
"default": ""
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "DockState",
"default": ""
}
],
"methods": []
},
"DockPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "DockProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "container",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the container's DOM element."
},
{
"name": "menu",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the list's DOM element."
},
{
"name": "menuitem",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the list item's DOM element."
},
{
"name": "content",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the content's DOM element."
},
{
"name": "action",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the action's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the icon's DOM element."
}
],
"methods": []
},
"DockPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"DockState": {
"description": "Defines current inline state in Dock component.",
"relatedProp": "",
"props": [
{
"name": "id",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current id state as a string."
},
{
"name": "currentIndex",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Current index as a number."
},
{
"name": "focused",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current focus state as a boolean."
},
{
"name": "focusedOptionIndex",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Current focused item index as a number."
}
],
"methods": []
},
"DockTooltipOptions": { "DockTooltipOptions": {
"description": "Defines tooltip options", "description": "Defines tooltip options",
"relatedProp": "", "relatedProp": "",
@ -13018,6 +13154,14 @@
"type": "string", "type": "string",
"default": "", "default": "",
"description": "Establishes a string value that labels the component." "description": "Establishes a string value that labels the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "DockPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
} }
], ],
"methods": [] "methods": []
@ -13089,6 +13233,14 @@
] ]
} }
} }
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"DockPassThroughOptionType": {
"values": "DockPassThroughAttributes | (options: DockPassThroughMethodOptions) => DockPassThroughAttributes | null | undefined"
}
}
} }
}, },
"dropdown": { "dropdown": {