UNPKG

common-intellisense

Version:
1,164 lines (1,163 loc) 4.38 MB
{ "accordion": { "description": "Accordion groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/accordion/)", "components": { "default": { "description": "Accordion groups a collection of contents in tabs.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [] } } }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { "AccordionPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", "props": [ { "name": "instance", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines instance." }, { "name": "props", "optional": false, "readonly": false, "type": "AccordionProps", "default": "", "description": "Defines valid properties." }, { "name": "state", "optional": false, "readonly": false, "type": "AccordionState", "default": "", "description": "Defines current inline state." }, { "name": "attrs", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines valid attributes." }, { "name": "parent", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines parent options." }, { "name": "global", "optional": false, "readonly": false, "type": "undefined | object", "default": "", "description": "Defines passthrough(pt) options in global config." } ], "methods": [] }, "AccordionTabOpenEvent": { "description": "Custom tab open event.", "relatedProp": "AccordionEmitsOptions.tab-open", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "MouseEvent", "default": "", "description": "Browser mouse event." }, { "name": "index", "optional": false, "readonly": false, "type": "number", "default": "", "description": "Opened tab index." } ], "methods": [], "extendedBy": "AccordionTabCloseEvent,AccordionClickEvent" }, "AccordionTabCloseEvent": { "description": "Custom tab close event.", "relatedProp": "AccordionEmitsOptions.tab-close", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "MouseEvent", "default": "", "description": "Browser mouse event." }, { "name": "index", "optional": false, "readonly": false, "type": "number", "default": "", "description": "Opened tab index." } ], "methods": [], "extendedTypes": "AccordionTabOpenEvent" }, "AccordionClickEvent": { "description": "Custom tab open event.", "relatedProp": "AccordionEmitsOptions.tab-open", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "MouseEvent", "default": "", "description": "Browser mouse event." }, { "name": "index", "optional": false, "readonly": false, "type": "number", "default": "", "description": "Opened tab index." } ], "methods": [], "extendedTypes": "AccordionTabOpenEvent" }, "AccordionPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "AccordionProps.pt", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "AccordionPassThroughOptionType", "default": "", "description": "Used to pass attributes to the root's DOM element." }, { "name": "hooks", "optional": true, "readonly": false, "type": "any", "default": "", "description": "Used to manage all lifecycle hooks." } ], "methods": [] }, "AccordionPassThroughAttributes": { "description": "Custom passthrough attributes for each DOM elements", "relatedProp": "", "props": [ { "name": "[key: string]", "optional": false, "readonly": false, "type": "any" } ], "methods": [] }, "AccordionState": { "description": "Defines current inline state in Accordion component.", "relatedProp": "", "props": [ { "name": "id", "optional": false, "readonly": false, "type": "string", "default": "", "description": "Current id state as a string" }, { "name": "d_value", "optional": false, "readonly": false, "type": "string | string[]", "default": "", "description": "Current active value state." } ], "methods": [] }, "AccordionProps": { "description": "Defines valid properties in Accordion component.", "relatedProp": "", "props": [ { "name": "value", "optional": true, "readonly": false, "type": "null | string | number | string[] | number[]", "default": "null", "description": "Value of the active panel or an array of values in multiple mode." }, { "name": "multiple", "optional": true, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, multiple tabs can be activated at the same time." }, { "name": "activeIndex", "optional": true, "readonly": false, "type": "null | number | number[]", "default": "null", "description": "Index of the active tab or an array of indexes in multiple mode.", "deprecated": "since v4. Use value property instead." }, { "name": "lazy", "optional": true, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css." }, { "name": "expandIcon", "optional": true, "readonly": false, "type": "string", "default": "", "description": "Icon of a collapsed tab." }, { "name": "collapseIcon", "optional": true, "readonly": false, "type": "string", "default": "", "description": "Icon of an expanded tab." }, { "name": "tabindex", "optional": true, "readonly": false, "type": "number", "default": "0", "description": "Index of the element in tabbing order." }, { "name": "selectOnFocus", "optional": true, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, the focused tab is activated." }, { "name": "dt", "optional": true, "readonly": false, "type": "any", "default": "", "description": "It generates scoped CSS variables using design tokens for the component." }, { "name": "pt", "optional": true, "readonly": false, "type": "PassThrough<AccordionPassThroughOptions>", "default": "", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": true, "readonly": false, "type": "any", "default": "", "description": "Used to configure passthrough(pt) options of the component." }, { "name": "unstyled", "optional": true, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, it removes component related styles in the core." } ], "methods": [] }, "AccordionSlots": { "description": "Defines valid slots in Accordion slots.", "relatedProp": "", "props": [], "methods": [ { "name": "default", "parameters": [], "returnType": "VNode<RendererNode, RendererElement, Object>[]", "description": "Default slot to detect AccordionTab components." }, { "name": "collapseicon", "parameters": [], "returnType": "VNode<RendererNode, RendererElement, Object>[]", "description": "Custom collapse icon template." }, { "name": "expandicon", "parameters": [], "returnType": "VNode<RendererNode, RendererElement, Object>[]", "description": "Custom expand icon template." } ] }, "AccordionEmitsOptions": { "description": "Defines valid emits in Accordion component.", "relatedProp": "", "props": [], "methods": [ { "name": "update:value", "parameters": [ { "name": "value", "optional": false, "type": "undefined | null | string | string[]", "description": "Value of new active panel." } ], "returnType": "void", "description": "Emitted when the active panel changes." }, { "name": "update:activeIndex", "parameters": [ { "name": "value", "optional": false, "type": "undefined | number", "description": "Index of new active tab." } ], "returnType": "void", "description": "Emitted when the active tab changes.", "deprecated": "since v4. Use update:value emit instead." }, { "name": "tab-open", "parameters": [ { "name": "event", "optional": false, "type": "AccordionTabOpenEvent", "description": "Custom tab open event." } ], "returnType": "void", "description": "Callback to invoke when a tab gets expanded.", "deprecated": "since v4." }, { "name": "tab-close", "parameters": [ { "name": "event", "optional": false, "type": "AccordionTabCloseEvent", "description": "Custom tab close event." } ], "returnType": "void", "description": "Callback to invoke when an active tab is collapsed by clicking on the header.", "deprecated": "since v4." }, { "name": "tab-click", "parameters": [ { "name": "event", "optional": false, "type": "AccordionClickEvent", "description": "Custom tab click event." } ], "returnType": "void", "description": "Callback to invoke when an active tab is clicked.", "deprecated": "since v4." } ] } } }, "tokens": { "description": "Define design tokens used by the component.", "values": { "AccordionPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "props": [] }, "AccordionTabOpenEvent": { "description": "Custom tab open event.", "props": [] }, "AccordionTabCloseEvent": { "description": "Custom tab close event.", "props": [] }, "AccordionClickEvent": { "description": "Custom tab open event.", "props": [] }, "AccordionPassThroughOptions": { "description": "Custom passthrough(pt) options.", "props": [] }, "AccordionPassThroughAttributes": { "description": "Custom passthrough attributes for each DOM elements", "props": [] }, "AccordionState": { "description": "Defines current inline state in Accordion component.", "props": [] }, "AccordionProps": { "description": "Defines valid properties in Accordion component.", "props": [] }, "AccordionSlots": { "description": "Defines valid slots in Accordion slots.", "props": [] }, "AccordionEmitsOptions": { "description": "Defines valid emits in Accordion component.", "props": [] } } }, "types": { "description": "Defines the custom types used by the module.", "values": { "AccordionPassThroughOptionType": { "values": "AccordionPassThroughAttributes | (options: AccordionPassThroughMethodOptions) => undefined | string | null | undefined" }, "AccordionEmits": { "values": "EmitFn<AccordionEmitsOptions>" } } } }, "accordionstyle": { "description": "Accordion groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/accordion/)", "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { "AccordionStyle": { "relatedProp": "", "props": [], "methods": [], "extendedTypes": "default" } } }, "tokens": { "description": "Define design tokens used by the component.", "values": { "AccordionStyle": { "props": [] } } }, "enumerations": { "values": { "AccordionClasses": { "members": [ { "name": "root", "optional": false, "readonly": false, "value": "\"p-accordion\"", "description": "Class name of the root element" } ] } } } }, "accordioncontent": { "description": "AccordionContent is a helper component for Accordion component.\n\n[Live Demo](https://www.primevue.org/accordion/)", "components": { "default": { "description": "AccordionContent is a helper component for Accordion component.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [] } } }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { "AccordionContentPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", "props": [ { "name": "instance", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines instance." }, { "name": "props", "optional": false, "readonly": false, "type": "AccordionContentProps", "default": "", "description": "Defines valid properties." }, { "name": "context", "optional": false, "readonly": false, "type": "AccordionContentContext", "default": "", "description": "Defines current options." }, { "name": "attrs", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines valid attributes." }, { "name": "parent", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines parent options." }, { "name": "global", "optional": false, "readonly": false, "type": "undefined | object", "default": "", "description": "Defines passthrough(pt) options in global config." } ], "methods": [] }, "AccordionContentPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "AccordionContentProps.pt", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "AccordionContentPassThroughOptionType", "default": "", "description": "Used to pass attributes to the root's DOM element." }, { "name": "transition", "optional": true, "readonly": false, "type": "AccordionContentPassThroughOptionType", "default": "", "description": "Used to pass attributes to the transition's DOM element." }, { "name": "content", "optional": true, "readonly": false, "type": "AccordionContentPassThroughOptionType", "default": "", "description": "Used to pass attributes to the content's DOM element." }, { "name": "hooks", "optional": true, "readonly": false, "type": "any", "default": "", "description": "Used to manage all lifecycle hooks." } ], "methods": [] }, "AccordionContentPassThroughAttributes": { "relatedProp": "", "props": [ { "name": "[key: string]", "optional": false, "readonly": false, "type": "any" } ], "methods": [] }, "AccordionContentProps": { "description": "Defines valid properties in AccordionContent component.", "relatedProp": "", "props": [ { "name": "as", "optional": true, "readonly": false, "type": "string | Component", "default": "DIV", "description": "Use to change the HTML tag of root element." }, { "name": "asChild", "optional": true, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, it changes the default rendered element for the one passed as a child element." }, { "name": "dt", "optional": true, "readonly": false, "type": "any", "default": "", "description": "It generates scoped CSS variables using design tokens for the component." }, { "name": "pt", "optional": true, "readonly": false, "type": "PassThrough<AccordionContentPassThroughOptions>", "default": "", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": true, "readonly": false, "type": "any", "default": "", "description": "Used to configure passthrough(pt) options of the component." } ], "methods": [] }, "AccordionContentContext": { "description": "Defines current options in AccordionContent component.", "relatedProp": "", "props": [ { "name": "active", "optional": false, "readonly": false, "type": "boolean", "default": "", "description": "Whether the item is active." } ], "methods": [] }, "AccordionContentSlots": { "description": "Defines valid slots in AccordionContent slots.", "relatedProp": "", "props": [], "methods": [ { "name": "default", "parameters": [], "returnType": "VNode<RendererNode, RendererElement, Object>[]", "description": "Custom content template." } ] }, "AccordionContentEmitsOptions": { "relatedProp": "", "props": [], "methods": [] } } }, "tokens": { "description": "Define design tokens used by the component.", "values": { "AccordionContentPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "props": [] }, "AccordionContentPassThroughOptions": { "description": "Custom passthrough(pt) options.", "props": [] }, "AccordionContentPassThroughAttributes": { "props": [] }, "AccordionContentProps": { "description": "Defines valid properties in AccordionContent component.", "props": [] }, "AccordionContentContext": { "description": "Defines current options in AccordionContent component.", "props": [] }, "AccordionContentSlots": { "description": "Defines valid slots in AccordionContent slots.", "props": [] }, "AccordionContentEmitsOptions": { "props": [] } } }, "types": { "description": "Defines the custom types used by the module.", "values": { "AccordionContentPassThroughOptionType": { "values": "AccordionContentPassThroughAttributes | (options: AccordionContentPassThroughMethodOptions) => undefined | string | null | undefined" }, "AccordionContentEmits": { "values": "EmitFn<AccordionContentEmitsOptions>" } } } }, "accordioncontentstyle": { "description": "AccordionContent is a helper component for Accordion component.\n\n[Live Demo](https://www.primevue.org/accordion/)", "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { "AccordionContentStyle": { "relatedProp": "", "props": [], "methods": [], "extendedTypes": "default" } } }, "tokens": { "description": "Define design tokens used by the component.", "values": { "AccordionContentStyle": { "props": [] } } }, "enumerations": { "values": { "AccordionContentClasses": { "members": [ { "name": "root", "optional": false, "readonly": false, "value": "\"p-accordioncontent\"", "description": "Class name of the root element" }, { "name": "content", "optional": false, "readonly": false, "value": "\"p-accordioncontent-content\"", "description": "Class name of the content element" } ] } } } }, "accordionheader": { "description": "AccordionHeader is a helper component for Accordion component.\n\n[Live Demo](https://www.primevue.org/accordion/)", "components": { "default": { "description": "AccordionHeader is a helper component for Accordion component.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [] } } }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { "AccordionHeaderPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", "props": [ { "name": "instance", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines instance." }, { "name": "props", "optional": false, "readonly": false, "type": "AccordionHeaderProps", "default": "", "description": "Defines valid properties." }, { "name": "context", "optional": false, "readonly": false, "type": "AccordionHeaderContext", "default": "", "description": "Defines current options." }, { "name": "attrs", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines valid attributes." }, { "name": "parent", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines parent options." }, { "name": "global", "optional": false, "readonly": false, "type": "undefined | object", "default": "", "description": "Defines passthrough(pt) options in global config." } ], "methods": [] }, "AccordionHeaderPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "AccordionHeaderProps.pt", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "AccordionHeaderPassThroughOptionType", "default": "", "description": "Used to pass attributes to the root's DOM element." }, { "name": "toggleicon", "optional": true, "readonly": false, "type": "AccordionHeaderPassThroughOptionType", "default": "", "description": "Used to pass attributes to the root's DOM element." }, { "name": "hooks", "optional": true, "readonly": false, "type": "any", "default": "", "description": "Used to manage all lifecycle hooks." } ], "methods": [] }, "AccordionHeaderPassThroughAttributes": { "relatedProp": "", "props": [ { "name": "[key: string]", "optional": false, "readonly": false, "type": "any" } ], "methods": [] }, "AccordionHeaderProps": { "description": "Defines valid properties in AccordionHeader component.", "relatedProp": "", "props": [ { "name": "as", "optional": true, "readonly": false, "type": "string | Component", "default": "BUTTON", "description": "Use to change the HTML tag of root element." }, { "name": "asChild", "optional": true, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, it changes the default rendered element for the one passed as a child element." }, { "name": "dt", "optional": true, "readonly": false, "type": "any", "default": "", "description": "It generates scoped CSS variables using design tokens for the component." }, { "name": "pt", "optional": true, "readonly": false, "type": "PassThrough<AccordionHeaderPassThroughOptions>", "default": "", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": true, "readonly": false, "type": "any", "default": "", "description": "Used to configure passthrough(pt) options of the component." } ], "methods": [] }, "AccordionHeaderContext": { "description": "Defines current options in AccordionHeader component.", "relatedProp": "", "props": [ { "name": "active", "optional": false, "readonly": false, "type": "boolean", "default": "", "description": "Whether the item is active." } ], "methods": [] }, "AccordionHeaderSlots": { "description": "Defines valid slots in AccordionHeader slots.", "relatedProp": "", "props": [], "methods": [ { "name": "default", "parameters": [], "returnType": "VNode<RendererNode, RendererElement, Object>[]", "description": "Custom content template." }, { "name": "toggleicon", "parameters": [], "returnType": "VNode<RendererNode, RendererElement, Object>[]", "description": "Custom toggleicon template." } ] }, "AccordionHeaderEmitsOptions": { "relatedProp": "", "props": [], "methods": [] } } }, "tokens": { "description": "Define design tokens used by the component.", "values": { "AccordionHeaderPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "props": [] }, "AccordionHeaderPassThroughOptions": { "description": "Custom passthrough(pt) options.", "props": [] }, "AccordionHeaderPassThroughAttributes": { "props": [] }, "AccordionHeaderProps": { "description": "Defines valid properties in AccordionHeader component.", "props": [] }, "AccordionHeaderContext": { "description": "Defines current options in AccordionHeader component.", "props": [] }, "AccordionHeaderSlots": { "description": "Defines valid slots in AccordionHeader slots.", "props": [] }, "AccordionHeaderEmitsOptions": { "props": [] } } }, "types": { "description": "Defines the custom types used by the module.", "values": { "AccordionHeaderPassThroughOptionType": { "values": "AccordionHeaderPassThroughAttributes | (options: AccordionHeaderPassThroughMethodOptions) => undefined | string | null | undefined" }, "AccordionHeaderEmits": { "values": "EmitFn<AccordionHeaderEmitsOptions>" } } } }, "accordionheaderstyle": { "description": "AccordionHeader is a helper component for Accordion component.\n\n[Live Demo](https://www.primevue.org/accordion/)", "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { "AccordionHeaderStyle": { "relatedProp": "", "props": [], "methods": [], "extendedTypes": "default" } } }, "tokens": { "description": "Define design tokens used by the component.", "values": { "AccordionHeaderStyle": { "props": [] } } }, "enumerations": { "values": { "AccordionHeaderClasses": { "members": [ { "name": "root", "optional": false, "readonly": false, "value": "\"p-accordionheader\"", "description": "Class name of the root element" }, { "name": "toggleicon", "optional": false, "readonly": false, "value": "\"p-accordionheader-toggle-icon\"", "description": "Class name of the toggleicon element" } ] } } } }, "accordionpanel": { "description": "AccordionPanel is a helper component for Accordion component.\n\n[Live Demo](https://www.primevue.org/accordion/)", "components": { "default": { "description": "AccordionPanel is a helper component for Accordion component.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [] } } }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { "AccordionPanelPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", "props": [ { "name": "instance", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines instance." }, { "name": "props", "optional": false, "readonly": false, "type": "AccordionPanelProps", "default": "", "description": "Defines valid properties." }, { "name": "context", "optional": false, "readonly": false, "type": "AccordionPanelContext", "default": "", "description": "Defines current options." }, { "name": "attrs", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines valid attributes." }, { "name": "parent", "optional": false, "readonly": false, "type": "any", "default": "", "description": "Defines parent options." }, { "name": "global", "optional": false, "readonly": false, "type": "undefined | object", "default": "",