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-06 20:35:11 +00:00
parent 510d4b2918
commit 9353013410
1 changed files with 160 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27250,6 +27250,150 @@
"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": {
"RatingPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "RatingProps",
"default": ""
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "RatingState",
"default": ""
}
],
"methods": []
},
"RatingPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "RatingProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "cancelItem",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the cancel item's DOM element."
},
{
"name": "cancelInputAria",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the input aria's DOM element."
},
{
"name": "cancelInput",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the cancel input's DOM element."
},
{
"name": "cancelIcon",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the cancel icon's DOM element."
},
{
"name": "item",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the item's DOM element."
},
{
"name": "itemInputAria",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the item input aria's DOM element."
},
{
"name": "itemInput",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the item input's DOM element."
},
{
"name": "onIcon",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the on icon's DOM element."
},
{
"name": "offIcon",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the off icon's DOM element."
}
],
"methods": []
},
"RatingPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"RatingState": {
"description": "Defines current inline state in Rating component.",
"relatedProp": "",
"props": [
{
"name": "name",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "name state as a number."
},
{
"name": "focusedOptionIndex",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "focusedOptionIndex state as a number."
}
],
"methods": []
},
"RatingChangeEvent": { "RatingChangeEvent": {
"description": "Custom change event.", "description": "Custom change event.",
"relatedProp": "RatingEmits.change", "relatedProp": "RatingEmits.change",
@ -27351,6 +27495,14 @@
"default": "", "default": "",
"description": "Icon for the cancelable state.", "description": "Icon for the cancelable state.",
"deprecated": "since v3.27.0. Use 'cancelicon' slot." "deprecated": "since v3.27.0. Use 'cancelicon' slot."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "RatingPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
} }
], ],
"methods": [] "methods": []
@ -27454,6 +27606,14 @@
] ]
} }
} }
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"RatingPassThroughOptionType": {
"values": "RatingPassThroughAttributes | (options: RatingPassThroughMethodOptions) => RatingPassThroughAttributes | null | undefined"
}
}
} }
}, },
"ripple": { "ripple": {