diff --git a/api-generator/build-apidoc.js b/api-generator/build-apidoc.js index ca27a821a..af2bd3e24 100644 --- a/api-generator/build-apidoc.js +++ b/api-generator/build-apidoc.js @@ -33,8 +33,7 @@ app.bootstrap({ disableSources: true, logLevel: 'Error', sort: ['source-order'], - exclude: ['node_modules', 'components/lib/**/*.js'], - + exclude: ['node_modules', 'components/lib/**/*.js'] }); const project = app.convert(); diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index b3d18e6e1..c30f6910a 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -16,102 +16,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "AccordionClickEvent": { - "description": "Custom tab open event.", - "relatedProp": "AccordionEmits.tab-open", - "props": [ - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Opened tab index." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "MouseEvent", - "default": "", - "description": "Browser mouse event." - } - ], - "methods": [], - "extendedTypes": "AccordionTabOpenEvent" - }, - "AccordionEmits": { - "description": "Defines valid emits in Accordion component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "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." - }, - { - "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." - }, - { - "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." - }, - { - "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." - } - ] - }, - "AccordionPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "AccordionPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -133,6 +37,78 @@ ], "methods": [] }, + "AccordionTabOpenEvent": { + "description": "Custom tab open event.", + "relatedProp": "AccordionEmits.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": "AccordionEmits.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": "AccordionEmits.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", @@ -148,10 +124,54 @@ ], "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_activeIndex", + "optional": false, + "readonly": false, + "type": "number | number[]", + "default": "", + "description": "Current active index state." + } + ], + "methods": [] + }, "AccordionProps": { "description": "Defines valid properties in Accordion component.", "relatedProp": "", "props": [ + { + "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, @@ -160,22 +180,6 @@ "default": "null", "description": "Index of the active tab or an array of indexes in multiple mode." }, - { - "name": "collapseIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-down", - "description": "Icon of an expanded tab." - }, - { - "name": "expandIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-right", - "description": "Icon of a collapsed tab." - }, { "name": "lazy", "optional": true, @@ -185,20 +189,28 @@ "description": "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css." }, { - "name": "multiple", + "name": "expandIcon", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, multiple tabs can be activated at the same time." + "type": "string", + "default": "pi pi-chevron-right", + "description": "Icon of a collapsed tab." }, { - "name": "pt", + "name": "collapseIcon", "optional": true, "readonly": false, - "type": "AccordionPassThroughOptions", - "default": "", - "description": "Uses to pass attributes to DOM elements inside the component." + "type": "string", + "default": "pi pi-chevron-down", + "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", @@ -209,12 +221,12 @@ "description": "When enabled, the focused tab is activated." }, { - "name": "tabindex", + "name": "pt", "optional": true, "readonly": false, - "type": "number", - "default": "0", - "description": "Index of the element in tabbing order." + "type": "AccordionPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -232,76 +244,64 @@ } ] }, - "AccordionState": { - "description": "Defines current inline state in Accordion component.", + "AccordionEmits": { + "description": "Defines valid emits in Accordion component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { - "name": "d_activeIndex", - "optional": false, - "readonly": false, - "type": "number | number[]", - "default": "", - "description": "Current active index state." + "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." }, { - "name": "id", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Current id state as a string" - } - ], - "methods": [] - }, - "AccordionTabCloseEvent": { - "description": "Custom tab close event.", - "relatedProp": "AccordionEmits.tab-close", - "props": [ - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Opened tab index." + "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." }, { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "MouseEvent", - "default": "", - "description": "Browser mouse event." - } - ], - "methods": [], - "extendedTypes": "AccordionTabOpenEvent" - }, - "AccordionTabOpenEvent": { - "description": "Custom tab open event.", - "relatedProp": "AccordionEmits.tab-open", - "props": [ - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Opened tab index." + "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." }, { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "MouseEvent", - "default": "", - "description": "Browser mouse event." + "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." } - ], - "methods": [], - "extendedBy": "AccordionTabCloseEvent,AccordionClickEvent" + ] } } }, @@ -331,42 +331,23 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "AccordionTabEmits": { - "description": "Defines valid emits in AcordionTab component.", - "relatedProp": "", - "props": [], - "methods": [] - }, - "AccordionTabPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "AccordionTabPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", "props": [ - { - "name": "parent", - "optional": false, - "readonly": false, - "type": "AccordionPassThroughOptions", - "default": "" - }, { "name": "props", "optional": false, "readonly": false, "type": "AccordionTabProps", "default": "" + }, + { + "name": "parent", + "optional": false, + "readonly": false, + "type": "AccordionPassThroughOptions", + "default": "" } ], "methods": [] @@ -376,12 +357,12 @@ "relatedProp": "AccordionTabProps.pt", "props": [ { - "name": "content", + "name": "root", "optional": true, "readonly": false, "type": "AccordionTabPassThroughOptionType", "default": "", - "description": "Uses to pass attributes to the content's DOM element." + "description": "Uses to pass attributes to the root's DOM element." }, { "name": "header", @@ -415,14 +396,6 @@ "default": "", "description": "Uses to pass attributes to the headertitle's DOM element." }, - { - "name": "root", - "optional": true, - "readonly": false, - "type": "AccordionTabPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the root's DOM element." - }, { "name": "toggleablecontent", "optional": true, @@ -430,6 +403,27 @@ "type": "AccordionTabPassThroughOptionType", "default": "", "description": "Uses to pass attributes to the toggleablecontent's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "AccordionTabPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + } + ], + "methods": [] + }, + "AccordionTabPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" } ], "methods": [] @@ -438,39 +432,6 @@ "description": "Defines valid properties in AccordionTab component.", "relatedProp": "", "props": [ - { - "name": "contentClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the tab content." - }, - { - "name": "contentProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLDivElement to the tab content.", - "deprecated": "since v3.26.0. Use 'pt' property instead." - }, - { - "name": "contentStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the tab content." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the tab is disabled." - }, { "name": "header", "optional": true, @@ -480,13 +441,12 @@ "description": "Orientation of tab headers." }, { - "name": "headerActionProps", + "name": "headerStyle", "optional": true, "readonly": false, - "type": "AnchorHTMLAttributes", + "type": "any", "default": "", - "description": "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.", - "deprecated": "since v3.26.0. Use 'pt' property instead." + "description": "Inline style of the tab header." }, { "name": "headerClass", @@ -506,12 +466,46 @@ "deprecated": "since v3.26.0. Use 'pt' property instead." }, { - "name": "headerStyle", + "name": "headerActionProps", + "optional": true, + "readonly": false, + "type": "AnchorHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.", + "deprecated": "since v3.26.0. Use 'pt' property instead." + }, + { + "name": "contentStyle", "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Inline style of the tab header." + "description": "Inline style of the tab content." + }, + { + "name": "contentClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the tab content." + }, + { + "name": "contentProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLDivElement to the tab content.", + "deprecated": "since v3.26.0. Use 'pt' property instead." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the tab is disabled." }, { "name": "pt", @@ -555,6 +549,12 @@ "description": "Custom icon for the header section of a AccordionTab is defined using the headericon template." } ] + }, + "AccordionTabEmits": { + "description": "Defines valid emits in AcordionTab component.", + "relatedProp": "", + "props": [], + "methods": [] } } }, @@ -578,7 +578,7 @@ "relatedProp": "", "props": [ { - "name": "BETWEEN", + "name": "STARTS_WITH", "optional": false, "readonly": true, "type": "string", @@ -592,28 +592,7 @@ "default": "" }, { - "name": "DATE_AFTER", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, - { - "name": "DATE_BEFORE", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, - { - "name": "DATE_IS", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, - { - "name": "DATE_IS_NOT", + "name": "NOT_CONTAINS", "optional": false, "readonly": true, "type": "string", @@ -634,14 +613,7 @@ "default": "" }, { - "name": "GREATER_THAN", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, - { - "name": "GREATER_THAN_OR_EQUAL_TO", + "name": "NOT_EQUALS", "optional": false, "readonly": true, "type": "string", @@ -669,21 +641,49 @@ "default": "" }, { - "name": "NOT_CONTAINS", + "name": "GREATER_THAN", "optional": false, "readonly": true, "type": "string", "default": "" }, { - "name": "NOT_EQUALS", + "name": "GREATER_THAN_OR_EQUAL_TO", "optional": false, "readonly": true, "type": "string", "default": "" }, { - "name": "STARTS_WITH", + "name": "BETWEEN", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, + { + "name": "DATE_IS", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, + { + "name": "DATE_IS_NOT", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, + { + "name": "DATE_BEFORE", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, + { + "name": "DATE_AFTER", "optional": false, "readonly": true, "type": "string", @@ -820,13 +820,6 @@ "type": "string", "default": "" }, - { - "name": "ARROW_A", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, { "name": "ARROW_CIRCLE_DOWN", "optional": false, @@ -876,13 +869,6 @@ "type": "string", "default": "" }, - { - "name": "ARROW_H", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, { "name": "ARROW_LEFT", "optional": false, @@ -925,6 +911,13 @@ "type": "string", "default": "" }, + { + "name": "ARROW_H", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "ARROW_V", "optional": false, @@ -932,6 +925,13 @@ "type": "string", "default": "" }, + { + "name": "ARROW_A", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "AT", "optional": false, @@ -1023,13 +1023,6 @@ "type": "string", "default": "" }, - { - "name": "CALCULATOR", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, { "name": "CALENDAR", "optional": false, @@ -1058,6 +1051,13 @@ "type": "string", "default": "" }, + { + "name": "CALCULATOR", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "CAMERA", "optional": false, @@ -1619,14 +1619,14 @@ "default": "" }, { - "name": "HOME", + "name": "HOURGLASS", "optional": false, "readonly": true, "type": "string", "default": "" }, { - "name": "HOURGLASS", + "name": "HOME", "optional": false, "readonly": true, "type": "string", @@ -2066,20 +2066,6 @@ "type": "string", "default": "" }, - { - "name": "SORT_ALPHA_ALT_DOWN", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, - { - "name": "SORT_ALPHA_ALT_UP", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, { "name": "SORT_ALPHA_DOWN", "optional": false, @@ -2087,6 +2073,13 @@ "type": "string", "default": "" }, + { + "name": "SORT_ALPHA_ALT_DOWN", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "SORT_ALPHA_UP", "optional": false, @@ -2094,6 +2087,13 @@ "type": "string", "default": "" }, + { + "name": "SORT_ALPHA_ALT_UP", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "SORT_ALT", "optional": false, @@ -2143,20 +2143,6 @@ "type": "string", "default": "" }, - { - "name": "SORT_NUMERIC_ALT_DOWN", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, - { - "name": "SORT_NUMERIC_ALT_UP", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, { "name": "SORT_NUMERIC_DOWN", "optional": false, @@ -2164,6 +2150,13 @@ "type": "string", "default": "" }, + { + "name": "SORT_NUMERIC_ALT_DOWN", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "SORT_NUMERIC_UP", "optional": false, @@ -2171,6 +2164,13 @@ "type": "string", "default": "" }, + { + "name": "SORT_NUMERIC_ALT_UP", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "SORT_UP", "optional": false, @@ -2297,6 +2297,13 @@ "type": "string", "default": "" }, + { + "name": "TH_LARGE", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "THUMBS_DOWN", "optional": false, @@ -2325,13 +2332,6 @@ "type": "string", "default": "" }, - { - "name": "TH_LARGE", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, { "name": "TICKET", "optional": false, @@ -2402,13 +2402,6 @@ "type": "string", "default": "" }, - { - "name": "USERS", - "optional": false, - "readonly": true, - "type": "string", - "default": "" - }, { "name": "USER_EDIT", "optional": false, @@ -2430,6 +2423,13 @@ "type": "string", "default": "" }, + { + "name": "USERS", + "optional": false, + "readonly": true, + "type": "string", + "default": "" + }, { "name": "VERIFIED", "optional": false, @@ -2528,7 +2528,7 @@ "relatedProp": "", "props": [ { - "name": "ERROR", + "name": "SUCCESS", "optional": false, "readonly": true, "type": "string", @@ -2542,14 +2542,14 @@ "default": "" }, { - "name": "SUCCESS", + "name": "WARN", "optional": false, "readonly": true, "type": "string", "default": "" }, { - "name": "WARN", + "name": "ERROR", "optional": false, "readonly": true, "type": "string", @@ -2601,193 +2601,6 @@ ], "methods": [] }, - "AutoCompleteCompleteEvent": { - "description": "Custom complete event.", - "relatedProp": "AutoCompleteEmits.complete", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "query", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Value to search with" - } - ], - "methods": [] - }, - "AutoCompleteDropdownClickEvent": { - "description": "Custom dropdown click event.", - "relatedProp": "AutoCompleteEmits['dropdown-click']", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "MouseEvent", - "default": "", - "description": "Browser mouse event" - }, - { - "name": "query", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Current value of the input field" - } - ], - "methods": [] - }, - "AutoCompleteEmits": { - "description": "Defines valid emits in AutoComplete component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "before-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is hidden." - }, - { - "name": "before-show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is shown." - }, - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "AutoCompleteChangeEvent", - "description": "Custom change event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "clear", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when input is cleared by the user." - }, - { - "name": "complete", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "AutoCompleteCompleteEvent", - "description": "Custom complete event." - } - ], - "returnType": "void", - "description": "Callback to invoke to search for suggestions." - }, - { - "name": "dropdown-click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "AutoCompleteDropdownClickEvent", - "description": "Custom dropdown click event." - } - ], - "returnType": "void", - "description": "Callback to invoke to when dropdown button is clicked." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is hidden." - }, - { - "name": "item-select", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "AutoCompleteItemSelectEvent", - "description": "Custom item select event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a suggestion is selected." - }, - { - "name": "item-unselect", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "AutoCompleteItemUnselectEvent", - "description": "Custom item unselect event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a selected value is removed." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is shown." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "AutoCompleteItemSelectEvent": { "description": "Custom item select event.", "relatedProp": "AutoCompleteEmits['item-select']", @@ -2836,130 +2649,71 @@ "methods": [], "extendedTypes": "AutoCompleteItemSelectEvent" }, + "AutoCompleteDropdownClickEvent": { + "description": "Custom dropdown click event.", + "relatedProp": "AutoCompleteEmits['dropdown-click']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "MouseEvent", + "default": "", + "description": "Browser mouse event" + }, + { + "name": "query", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current value of the input field" + } + ], + "methods": [] + }, + "AutoCompleteCompleteEvent": { + "description": "Custom complete event.", + "relatedProp": "AutoCompleteEmits.complete", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "query", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Value to search with" + } + ], + "methods": [] + }, "AutoCompleteProps": { "description": "Defines valid properties in AutoComplete component.", "relatedProp": "", "props": [ { - "name": "appendTo", + "name": "modelValue", "optional": true, "readonly": false, - "type": "string | HTMLElement", - "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." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", + "type": "any", "default": "", - "description": "Defines a string value that labels an interactive element." + "description": "Value of the component." }, { - "name": "aria-labelledby", + "name": "suggestions", "optional": true, "readonly": false, - "type": "string", + "type": "any[]", "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "autoHighlight", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "", - "deprecated": "since v3.16.0\nHighlights automatically the first item of the dropdown to be selected." - }, - { - "name": "autoOptionFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." - }, - { - "name": "completeOnFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to run a query when input receives focus." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "A property to uniquely identify an option." - }, - { - "name": "delay", - "optional": true, - "readonly": false, - "type": "number", - "default": "300", - "description": "Delay between keystrokes to wait before sending a query." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "dropdown", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Displays a button next to the input field when enabled." - }, - { - "name": "dropdownClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the dropdown button." - }, - { - "name": "dropdownIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-down", - "description": "Icon to display in the dropdown." - }, - { - "name": "dropdownMode", - "optional": true, - "readonly": false, - "type": "\"blank\" | \"current\"", - "default": "blank", - "description": "Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value." - }, - { - "name": "emptySearchMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptySelectionMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No selected item", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." + "description": "An array of suggestions to display." }, { "name": "field", @@ -2971,76 +2725,12 @@ "deprecated": "since v3.16.0. Use 'optionLabel' property instead.\nProperty name or getter function of a suggested object to resolve and display." }, { - "name": "forceSelection", + "name": "optionLabel", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", + "type": "string | Function", "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "loadingIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-spinner pi-spin", - "description": "Icon to display in loading state." - }, - { - "name": "minLength", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Minimum number of characters to initiate a search." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Value of the component." - }, - { - "name": "multiple", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Specifies if multiple values can be selected." + "description": "Property name or getter function to use as the label of an option." }, { "name": "optionDisabled", @@ -3050,14 +2740,6 @@ "default": "", "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." }, - { - "name": "optionGroupChildren", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function that refers to the children options of option group." - }, { "name": "optionGroupLabel", "optional": true, @@ -3067,12 +2749,157 @@ "description": "Property name or getter function to use as the label of an option group." }, { - "name": "optionLabel", + "name": "optionGroupChildren", "optional": true, "readonly": false, "type": "string | Function", "default": "", - "description": "Property name or getter function to use as the label of an option." + "description": "Property name or getter function that refers to the children options of option group." + }, + { + "name": "scrollHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "200px", + "description": "Maximum height of the suggestions panel." + }, + { + "name": "dropdown", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Displays a button next to the input field when enabled." + }, + { + "name": "dropdownMode", + "optional": true, + "readonly": false, + "type": "\"blank\" | \"current\"", + "default": "blank", + "description": "Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value." + }, + { + "name": "autoHighlight", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "", + "deprecated": "since v3.16.0\nHighlights automatically the first item of the dropdown to be selected." + }, + { + "name": "multiple", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Specifies if multiple values can be selected." + }, + { + "name": "placeholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Default text to display when no option is selected." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "A property to uniquely identify an option." + }, + { + "name": "minLength", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Minimum number of characters to initiate a search." + }, + { + "name": "delay", + "optional": true, + "readonly": false, + "type": "number", + "default": "300", + "description": "Delay between keystrokes to wait before sending a query." + }, + { + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "string | HTMLElement", + "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." + }, + { + "name": "forceSelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions." + }, + { + "name": "completeOnFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to run a query when input receives focus." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "panelStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the overlay panel." }, { "name": "panelClass", @@ -3091,20 +2918,28 @@ "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." }, { - "name": "panelStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the overlay panel." - }, - { - "name": "placeholder", + "name": "dropdownIcon", "optional": true, "readonly": false, "type": "string", + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." + }, + { + "name": "dropdownClass", + "optional": true, + "readonly": false, + "type": "string | object", "default": "", - "description": "Default text to display when no option is selected." + "description": "Style class of the dropdown button." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." }, { "name": "removeTokenIcon", @@ -3115,12 +2950,28 @@ "description": "Icon to display in chip remove action." }, { - "name": "scrollHeight", + "name": "virtualScrollerOptions", "optional": true, "readonly": false, - "type": "string", - "default": "200px", - "description": "Maximum height of the suggestions panel." + "type": "VirtualScrollerProps", + "default": "", + "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it." + }, + { + "name": "autoOptionFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." + }, + { + "name": "selectOnFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, the focused option is selected." }, { "name": "searchLocale", @@ -3138,14 +2989,6 @@ "default": "'{0} results are available'", "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." }, - { - "name": "selectOnFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, the focused option is selected." - }, { "name": "selectionMessage", "optional": true, @@ -3155,12 +2998,20 @@ "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { - "name": "suggestions", + "name": "emptySelectionMessage", "optional": true, "readonly": false, - "type": "any[]", - "default": "", - "description": "An array of suggestions to display." + "type": "string", + "default": "No selected item", + "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptySearchMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found", + "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." }, { "name": "tabindex", @@ -3171,12 +3022,20 @@ "description": "Index of the element in tabbing order." }, { - "name": "virtualScrollerOptions", + "name": "aria-label", "optional": true, "readonly": false, - "type": "VirtualScrollerProps", + "type": "string", "default": "", - "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it." + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." } ], "methods": [] @@ -3199,6 +3058,72 @@ "returnType": "VNode[]", "description": "Custom chip template." }, + { + "name": "header", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t suggestions: any, // Displayed options\n }", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template of panel." + }, + { + "name": "footer", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t suggestions: any, // Displayed options\n }", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template of panel." + }, + { + "name": "item", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "", + "deprecated": "since v3.16.0\nCustom content for each item." + }, + { + "name": "option", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." + }, + { + "name": "optiongroup", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: any, // undefined\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option group slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option group template." + }, { "name": "content", "parameters": [ @@ -3212,52 +3137,6 @@ "returnType": "VNode[]", "description": "Custom panel template." }, - { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template when there is no data to display." - }, - { - "name": "footer", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "footer slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom footer template of panel." - }, - { - "name": "header", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "header slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom header template of panel." - }, - { - "name": "item", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t item: any, // Option instance\n }", - "description": "item slot's params." - } - ], - "returnType": "VNode[]", - "description": "", - "deprecated": "since v3.16.0\nCustom content for each item." - }, { "name": "loader", "parameters": [ @@ -3272,30 +3151,151 @@ "description": "Custom loader template." }, { - "name": "option", + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template when there is no data to display." + } + ] + }, + "AutoCompleteEmits": { + "description": "Defines valid emits in AutoComplete component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", "parameters": [ { - "name": "scope", + "name": "value", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "option slot's params." + "type": "any", + "description": "New value." } ], - "returnType": "VNode[]", - "description": "Custom option template." + "returnType": "void", + "description": "Emitted when the value changes." }, { - "name": "optiongroup", + "name": "change", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t item: any, // undefined\n \t option: any, // Option instance\n }", - "description": "option group slot's params." + "type": "AutoCompleteChangeEvent", + "description": "Custom change event." } ], - "returnType": "VNode[]", - "description": "Custom option group template." + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "item-select", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "AutoCompleteItemSelectEvent", + "description": "Custom item select event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a suggestion is selected." + }, + { + "name": "item-unselect", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "AutoCompleteItemUnselectEvent", + "description": "Custom item unselect event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a selected value is removed." + }, + { + "name": "dropdown-click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "AutoCompleteDropdownClickEvent", + "description": "Custom dropdown click event." + } + ], + "returnType": "void", + "description": "Callback to invoke to when dropdown button is clicked." + }, + { + "name": "clear", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when input is cleared by the user." + }, + { + "name": "complete", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "AutoCompleteCompleteEvent", + "description": "Custom complete event." + } + ], + "returnType": "void", + "description": "Callback to invoke to search for suggestions." + }, + { + "name": "before-show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is shown." + }, + { + "name": "before-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is hidden." } ] } @@ -3319,38 +3319,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "AvatarEmits": { - "description": "Defines valid emits in Avatar component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "error", - "parameters": [], - "returnType": "void", - "description": "Triggered when an error occurs while loading an image file." - } - ] - }, "AvatarProps": { "description": "Defines valid properties in Avatar component.", "relatedProp": "", "props": [ { - "name": "aria-label", + "name": "label", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + "description": "Defines the text to display." }, { "name": "icon", @@ -3369,12 +3348,12 @@ "description": "Defines the image to display." }, { - "name": "label", + "name": "size", "optional": true, "readonly": false, - "type": "string", - "default": "", - "description": "Defines the text to display." + "type": "\"normal\" | \"large\" | \"xlarge\"", + "default": "normal", + "description": "Size of the element." }, { "name": "shape", @@ -3385,12 +3364,20 @@ "description": "Shape of the element." }, { - "name": "size", + "name": "aria-label", "optional": true, "readonly": false, - "type": "\"normal\" | \"large\" | \"xlarge\"", - "default": "normal", - "description": "Size of the element." + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." } ], "methods": [] @@ -3407,6 +3394,19 @@ "description": "Content can easily be customized with the default slot instead of using the built-in modes." } ] + }, + "AvatarEmits": { + "description": "Defines valid emits in Avatar component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "error", + "parameters": [], + "returnType": "void", + "description": "Triggered when an error occurs while loading an image file." + } + ] } } } @@ -3428,12 +3428,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "AvatarGroupEmits": { - "description": "Defines valid emits in AvatarGroup component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "AvatarGroupProps": { "description": "Defines valid properties in AvatarGroup component.", "relatedProp": "", @@ -3445,6 +3439,12 @@ "relatedProp": "", "props": [], "methods": [] + }, + "AvatarGroupEmits": { + "description": "Defines valid emits in AvatarGroup component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -3466,16 +3466,18 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "BadgeEmits": { - "description": "Defines valid emits in Badge component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "BadgeProps": { "description": "Defines valid properties in Badge component.", "relatedProp": "", "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "string | number", + "default": "", + "description": "Value to display inside the badge." + }, { "name": "severity", "optional": true, @@ -3491,14 +3493,6 @@ "type": "null | \"large\" | \"xlarge\"", "default": "", "description": "Size of the badge, valid options are 'large' and 'xlarge'." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "string | number", - "default": "", - "description": "Value to display inside the badge." } ], "methods": [] @@ -3515,6 +3509,12 @@ "description": "Content can easily be customized with the default slot instead of using the built-in display." } ] + }, + "BadgeEmits": { + "description": "Defines valid emits in Badge component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -3527,42 +3527,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "BadgeDirectiveBinding": { - "description": "Binding of Badge directive.", - "relatedProp": "", - "props": [ - { - "name": "modifiers", - "optional": true, - "readonly": false, - "type": "BadgeDirectiveModifiers", - "default": "", - "description": "Modifiers of the Badge." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Value of the Badge." - } - ], - "methods": [], - "extendedTypes": "Omit" - }, "BadgeDirectiveModifiers": { "description": "Defines modifiers of Badge directive.", "relatedProp": "", "props": [ - { - "name": "danger", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Danger severity for Badge directive." - }, { "name": "info", "optional": true, @@ -3586,9 +3554,41 @@ "type": "boolean", "default": "false", "description": "Warning severity for Badge directive." + }, + { + "name": "danger", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Danger severity for Badge directive." } ], "methods": [] + }, + "BadgeDirectiveBinding": { + "description": "Binding of Badge directive.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Value of the Badge." + }, + { + "name": "modifiers", + "optional": true, + "readonly": false, + "type": "BadgeDirectiveModifiers", + "default": "", + "description": "Modifiers of the Badge." + } + ], + "methods": [], + "extendedTypes": "Omit" } } } @@ -3610,6 +3610,58 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "BlockUIProps": { + "description": "Defines valid properties in BlockUI component", + "relatedProp": "", + "props": [ + { + "name": "blocked", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Controls the blocked state." + }, + { + "name": "fullScreen", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, the whole document gets blocked." + }, + { + "name": "baseZIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Base zIndex value to use in layering." + }, + { + "name": "autoZIndex", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to automatically manage layering." + } + ], + "methods": [] + }, + "BlockUISlots": { + "description": "Defines valid slots in BlockUI component", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "default", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content's slot." + } + ] + }, "BlockUIEmits": { "description": "Defines valid emits in BlockUI component", "relatedProp": "", @@ -3628,58 +3680,6 @@ "description": "Fired when the element gets unblocked." } ] - }, - "BlockUIProps": { - "description": "Defines valid properties in BlockUI component", - "relatedProp": "", - "props": [ - { - "name": "autoZIndex", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to automatically manage layering." - }, - { - "name": "baseZIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Base zIndex value to use in layering." - }, - { - "name": "blocked", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Controls the blocked state." - }, - { - "name": "fullScreen", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, the whole document gets blocked." - } - ], - "methods": [] - }, - "BlockUISlots": { - "description": "Defines valid slots in BlockUI component", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "default", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom content's slot." - } - ] } } } @@ -3701,16 +3701,34 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "BreadcrumbEmits": { - "description": "Defines valid emits in Breadcrumb component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "BreadcrumbProps": { "description": "Defines valid properties in Breadcrumb component.", "relatedProp": "", "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "An array of menuitems." + }, + { + "name": "home", + "optional": true, + "readonly": false, + "type": "MenuItem", + "default": "", + "description": "Configuration for the home icon." + }, + { + "name": "exact", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." + }, { "name": "aria-label", "optional": true, @@ -3726,30 +3744,6 @@ "type": "string", "default": "", "description": "Identifier of the underlying menu element." - }, - { - "name": "exact", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." - }, - { - "name": "home", - "optional": true, - "readonly": false, - "type": "MenuItem", - "default": "", - "description": "Configuration for the home icon." - }, - { - "name": "model", - "optional": true, - "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "An array of menuitems." } ], "methods": [] @@ -3773,6 +3767,12 @@ "description": "Custom item template." } ] + }, + "BreadcrumbEmits": { + "description": "Defines valid emits in Breadcrumb component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -3794,16 +3794,58 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ButtonEmits": { - "description": "Defines valid emits in Button component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "ButtonProps": { "description": "Defines valid properties in Button component.", "relatedProp": "", "props": [ + { + "name": "style", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the button." + }, + { + "name": "class", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the button." + }, + { + "name": "label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text of the button." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the icon." + }, + { + "name": "iconPos", + "optional": true, + "readonly": false, + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "left", + "description": "Position of the icon." + }, + { + "name": "iconClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the icon." + }, { "name": "badge", "optional": true, @@ -3820,54 +3862,6 @@ "default": "", "description": "Style class of the badge." }, - { - "name": "class", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the button." - }, - { - "name": "icon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Name of the icon." - }, - { - "name": "iconClass", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class of the icon." - }, - { - "name": "iconPos", - "optional": true, - "readonly": false, - "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "left", - "description": "Position of the icon." - }, - { - "name": "label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Text of the button." - }, - { - "name": "link", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Add a link style to the button." - }, { "name": "loading", "optional": true, @@ -3885,20 +3879,20 @@ "description": "Icon to display in loading state." }, { - "name": "outlined", + "name": "link", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Add a border class without a background initially." + "description": "Add a link style to the button." }, { - "name": "plain", + "name": "severity", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Add a plain textual class to the button without a background initially." + "type": "string", + "default": "", + "description": "Defines the style of the button." }, { "name": "raised", @@ -3917,12 +3911,20 @@ "description": "Add a circular border radius to the button." }, { - "name": "severity", + "name": "text", "optional": true, "readonly": false, - "type": "string", - "default": "", - "description": "Defines the style of the button." + "type": "boolean", + "default": "false", + "description": "Add a textual class to the button without a background initially." + }, + { + "name": "outlined", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a border class without a background initially." }, { "name": "size", @@ -3933,20 +3935,12 @@ "description": "Defines the size of the button." }, { - "name": "style", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the button." - }, - { - "name": "text", + "name": "plain", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Add a textual class to the button without a background initially." + "description": "Add a plain textual class to the button without a background initially." } ], "methods": [], @@ -3964,6 +3958,12 @@ "description": "Custom content such as icons, images and text can be placed inside the button via the default slot. Note that when slot is used, label, icon and badge properties are not included." } ] + }, + "ButtonEmits": { + "description": "Defines valid emits in Button component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -3985,177 +3985,29 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "CalendarBlurEvent": { - "description": "Custom Calendar blur event.", - "relatedProp": "CalendarEmits.blur", + "CalendarResponsiveOptions": { + "description": "Custom Calendar responsive options metadata.", + "relatedProp": "", "props": [ { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "value", + "name": "breakpoint", "optional": false, "readonly": false, "type": "string", "default": "", - "description": "Input value" + "description": "Breakpoint for responsive mode. Exp;" + }, + { + "name": "numMonths", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "The number of visible months on breakpoint." } ], "methods": [] }, - "CalendarEmits": { - "description": "Defines valid emits in Calendar component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "CalendarBlurEvent", - "description": "Blur event" - } - ], - "returnType": "void", - "description": "Callback to invoke on blur of input field." - }, - { - "name": "clear-click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when clear button is clicked." - }, - { - "name": "date-select", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "Date", - "description": "Selected value." - } - ], - "returnType": "void", - "description": "Callback to invoke when a date is selected." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Focus event" - } - ], - "returnType": "void", - "description": "Callback to invoke on focus of input field." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when datepicker panel is hidden." - }, - { - "name": "input", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event" - } - ], - "returnType": "void", - "description": "Callback to invoke when input field is being typed." - }, - { - "name": "keydown", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event" - } - ], - "returnType": "void", - "description": "Callback to invoke when a key is pressed." - }, - { - "name": "month-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "CalendarMonthChangeEvent", - "description": "Custom month change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a month is changed using the navigators." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when datepicker panel is shown." - }, - { - "name": "today-click", - "parameters": [ - { - "name": "date", - "optional": false, - "type": "Date", - "description": "Today as a date instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when today button is clicked." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "undefined | string | string[] | Date | Date[]", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - }, - { - "name": "year-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "CalendarYearChangeEvent", - "description": "Custom year change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a year is changed using the navigators." - } - ] - }, "CalendarMonthChangeEvent": { "description": "Custom Calendar month change event.", "relatedProp": "CalendarEmits['month-change']]", @@ -4179,49 +4031,71 @@ ], "methods": [] }, + "CalendarYearChangeEvent": { + "description": "Custom Calendar year change event.", + "relatedProp": "CalendarEmits['year-change']]", + "props": [ + { + "name": "month", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "New month." + }, + { + "name": "year", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "New year." + } + ], + "methods": [] + }, + "CalendarBlurEvent": { + "description": "Custom Calendar blur event.", + "relatedProp": "CalendarEmits.blur", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Input value" + } + ], + "methods": [] + }, "CalendarProps": { "description": "Defines valid properties in Calendar component.", "relatedProp": "", "props": [ { - "name": "appendTo", + "name": "modelValue", "optional": true, "readonly": false, - "type": "string | HTMLElement", - "default": "body", - "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." + "type": "null | string | string[] | Date | Date[]", + "default": "null", + "description": "Value of the component." }, { - "name": "aria-label", + "name": "selectionMode", "optional": true, "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "autoZIndex", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to automatically manage layering." - }, - { - "name": "baseZIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Base zIndex value to use in layering." + "type": "\"multiple\" | \"range\" | \"single\"", + "default": "single", + "description": "Defines the quantity of the selection." }, { "name": "dateFormat", @@ -4231,6 +4105,70 @@ "default": "", "description": "Format of the date. Defaults to PrimeVue Locale configuration." }, + { + "name": "inline", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, displays the calendar as inline instead of an overlay." + }, + { + "name": "showOtherMonths", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option." + }, + { + "name": "selectOtherMonths", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true." + }, + { + "name": "showIcon", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, displays a button with icon next to input." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-calendar", + "description": "Icon of the calendar button." + }, + { + "name": "previousIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-chevron-left", + "description": "Icon to show in the previous button." + }, + { + "name": "nextIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-chevron-right", + "description": "Icon to show in the next button." + }, + { + "name": "incrementIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-chevron-up", + "description": "Icon to show in each of the increment buttons." + }, { "name": "decrementIcon", "optional": true, @@ -4240,12 +4178,79 @@ "description": "Icon to show in each of the decrement buttons." }, { - "name": "disabled", + "name": "numberOfMonths", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Number of months to display." + }, + { + "name": "responsiveOptions", + "optional": true, + "readonly": false, + "type": "CalendarResponsiveOptions[]", + "default": "", + "description": "An array of options for responsive design." + }, + { + "name": "view", + "optional": true, + "readonly": false, + "type": "\"month\" | \"year\" | \"date\"", + "default": "date", + "description": "Type of view to display." + }, + { + "name": "touchUI", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "When present, it specifies that the component should be disabled." + "description": "When enabled, calendar overlay is displayed as optimized for touch devices." + }, + { + "name": "monthNavigator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the month should be rendered as a dropdown instead of text.", + "deprecated": "since version 3.9.0, Navigator is always on." + }, + { + "name": "yearNavigator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the year should be rendered as a dropdown instead of text.", + "deprecated": "since version 3.9.0, Navigator is always on." + }, + { + "name": "yearRange", + "optional": true, + "readonly": false, + "type": "string", + "default": "false", + "description": "The range of years displayed in the year drop-down in (nnnn:nnnn) format such as (2000:2020).", + "deprecated": "since version 3.9.0, Years are based on decades by default." + }, + { + "name": "minDate", + "optional": true, + "readonly": false, + "type": "Date", + "default": "", + "description": "The minimum selectable date." + }, + { + "name": "maxDate", + "optional": true, + "readonly": false, + "type": "Date", + "default": "", + "description": "The maximum selectable date." }, { "name": "disabledDates", @@ -4263,110 +4268,6 @@ "default": "", "description": "Array with disabled weekday numbers." }, - { - "name": "hideOnDateTimeSelect", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to hide the overlay on date selection when showTime is enabled." - }, - { - "name": "hideOnRangeSelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to hide the overlay on date selection is completed when selectionMode is range." - }, - { - "name": "hourFormat", - "optional": true, - "readonly": false, - "type": "\"12\" | \"24\"", - "default": "24", - "description": "Specifies hour format." - }, - { - "name": "icon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-calendar", - "description": "Icon of the calendar button." - }, - { - "name": "id", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the element." - }, - { - "name": "incrementIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-up", - "description": "Icon to show in each of the increment buttons." - }, - { - "name": "inline", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, displays the calendar as inline instead of an overlay." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "manualInput", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Wheter to allow prevents entering the date manually via typing." - }, - { - "name": "maxDate", - "optional": true, - "readonly": false, - "type": "Date", - "default": "", - "description": "The maximum selectable date." - }, { "name": "maxDateCount", "optional": true, @@ -4375,143 +4276,6 @@ "default": "", "description": "Maximum number of selectable dates in multiple mode." }, - { - "name": "minDate", - "optional": true, - "readonly": false, - "type": "Date", - "default": "", - "description": "The minimum selectable date." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "null | string | string[] | Date | Date[]", - "default": "null", - "description": "Value of the component." - }, - { - "name": "monthNavigator", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the month should be rendered as a dropdown instead of text.", - "deprecated": "since version 3.9.0, Navigator is always on." - }, - { - "name": "nextIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-right", - "description": "Icon to show in the next button." - }, - { - "name": "numberOfMonths", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Number of months to display." - }, - { - "name": "panelClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the overlay panel." - }, - { - "name": "panelProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." - }, - { - "name": "panelStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the overlay panel." - }, - { - "name": "placeholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text for the input." - }, - { - "name": "previousIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-left", - "description": "Icon to show in the previous button." - }, - { - "name": "readonly", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that an input field is read-only." - }, - { - "name": "responsiveOptions", - "optional": true, - "readonly": false, - "type": "CalendarResponsiveOptions[]", - "default": "", - "description": "An array of options for responsive design." - }, - { - "name": "selectOtherMonths", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true." - }, - { - "name": "selectionMode", - "optional": true, - "readonly": false, - "type": "\"multiple\" | \"range\" | \"single\"", - "default": "single", - "description": "Defines the quantity of the selection." - }, - { - "name": "shortYearCutoff", - "optional": true, - "readonly": false, - "type": "string", - "default": "+10", - "description": "The cutoff year for determining the century for a date." - }, - { - "name": "showButtonBar", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to display today and clear buttons at the footer." - }, - { - "name": "showIcon", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, displays a button with icon next to input." - }, { "name": "showOnFocus", "optional": true, @@ -4521,20 +4285,36 @@ "description": "When disabled, datepicker will not be visible with input focus." }, { - "name": "showOtherMonths", + "name": "autoZIndex", "optional": true, "readonly": false, "type": "boolean", "default": "true", - "description": "Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option." + "description": "Whether to automatically manage layering." }, { - "name": "showSeconds", + "name": "baseZIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Base zIndex value to use in layering." + }, + { + "name": "showButtonBar", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Whether to show the seconds in time picker." + "description": "Whether to display today and clear buttons at the footer." + }, + { + "name": "shortYearCutoff", + "optional": true, + "readonly": false, + "type": "string", + "default": "+10", + "description": "The cutoff year for determining the century for a date." }, { "name": "showTime", @@ -4545,12 +4325,20 @@ "description": "Whether to display timepicker." }, { - "name": "showWeek", + "name": "timeOnly", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "When enabled, calendar will show week numbers." + "description": "Whether to display timepicker only." + }, + { + "name": "hourFormat", + "optional": true, + "readonly": false, + "type": "\"12\" | \"24\"", + "default": "24", + "description": "Specifies hour format." }, { "name": "stepHour", @@ -4577,12 +4365,28 @@ "description": "Seconds to change per step." }, { - "name": "timeOnly", + "name": "showSeconds", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Whether to display timepicker only." + "description": "Whether to show the seconds in time picker." + }, + { + "name": "hideOnDateTimeSelect", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to hide the overlay on date selection when showTime is enabled." + }, + { + "name": "hideOnRangeSelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to hide the overlay on date selection is completed when selectionMode is range." }, { "name": "timeSeparator", @@ -4593,61 +4397,132 @@ "description": "Separator of time selector." }, { - "name": "touchUI", + "name": "showWeek", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "When enabled, calendar overlay is displayed as optimized for touch devices." + "description": "When enabled, calendar will show week numbers." }, { - "name": "view", + "name": "manualInput", "optional": true, "readonly": false, - "type": "\"month\" | \"year\" | \"date\"", - "default": "date", - "description": "Type of view to display." + "type": "boolean", + "default": "true", + "description": "Wheter to allow prevents entering the date manually via typing." }, { - "name": "yearNavigator", + "name": "disabled", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Whether the year should be rendered as a dropdown instead of text.", - "deprecated": "since version 3.9.0, Navigator is always on." + "description": "When present, it specifies that the component should be disabled." }, { - "name": "yearRange", + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that an input field is read-only." + }, + { + "name": "placeholder", "optional": true, "readonly": false, "type": "string", - "default": "false", - "description": "The range of years displayed in the year drop-down in (nnnn:nnnn) format such as (2000:2020).", - "deprecated": "since version 3.9.0, Years are based on decades by default." - } - ], - "methods": [] - }, - "CalendarResponsiveOptions": { - "description": "Custom Calendar responsive options metadata.", - "relatedProp": "", - "props": [ + "default": "", + "description": "Placeholder text for the input." + }, { - "name": "breakpoint", - "optional": false, + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." + }, + { + "name": "id", + "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Breakpoint for responsive mode. Exp;" + "description": "Identifier of the element." }, { - "name": "numMonths", - "optional": false, + "name": "inputId", + "optional": true, "readonly": false, - "type": "number", + "type": "string", "default": "", - "description": "The number of visible months on breakpoint." + "description": "Identifier of the underlying input element." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "panelStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the overlay panel." + }, + { + "name": "panelClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the overlay panel." + }, + { + "name": "panelProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." } ], "methods": [] @@ -4657,6 +4532,18 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template of panel." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template of panel." + }, { "name": "date", "parameters": [ @@ -4680,43 +4567,156 @@ ], "returnType": "VNode[]", "description": "Custom decade template." - }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template of panel." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template of panel." } ] }, - "CalendarYearChangeEvent": { - "description": "Custom Calendar year change event.", - "relatedProp": "CalendarEmits['year-change']]", - "props": [ + "CalendarEmits": { + "description": "Defines valid emits in Calendar component.", + "relatedProp": "", + "props": [], + "methods": [ { - "name": "month", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "New month." + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "undefined | string | string[] | Date | Date[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." }, { - "name": "year", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "New year." + "name": "input", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event" + } + ], + "returnType": "void", + "description": "Callback to invoke when input field is being typed." + }, + { + "name": "date-select", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "Date", + "description": "Selected value." + } + ], + "returnType": "void", + "description": "Callback to invoke when a date is selected." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when datepicker panel is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when datepicker panel is hidden." + }, + { + "name": "today-click", + "parameters": [ + { + "name": "date", + "optional": false, + "type": "Date", + "description": "Today as a date instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when today button is clicked." + }, + { + "name": "clear-click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when clear button is clicked." + }, + { + "name": "month-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "CalendarMonthChangeEvent", + "description": "Custom month change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a month is changed using the navigators." + }, + { + "name": "year-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "CalendarYearChangeEvent", + "description": "Custom year change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a year is changed using the navigators." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Focus event" + } + ], + "returnType": "void", + "description": "Callback to invoke on focus of input field." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "CalendarBlurEvent", + "description": "Blur event" + } + ], + "returnType": "void", + "description": "Callback to invoke on blur of input field." + }, + { + "name": "keydown", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event" + } + ], + "returnType": "void", + "description": "Callback to invoke when a key is pressed." } - ], - "methods": [] + ] } } } @@ -4738,29 +4738,26 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "CardEmits": { - "description": "Defines valid emits in Card component.", - "relatedProp": "", - "props": [], - "methods": [] - }, - "CardPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "CardPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "CardProps.pt", "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "CardPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "header", + "optional": true, + "readonly": false, + "type": "CardPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the header's DOM element." + }, { "name": "body", "optional": true, @@ -4769,6 +4766,22 @@ "default": "", "description": "Uses to pass attributes to the body's DOM element." }, + { + "name": "title", + "optional": true, + "readonly": false, + "type": "CardPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the title's DOM element." + }, + { + "name": "subtitle", + "optional": true, + "readonly": false, + "type": "CardPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the subtitle's DOM element." + }, { "name": "content", "optional": true, @@ -4784,38 +4797,19 @@ "type": "CardPassThroughOptionType", "default": "", "description": "Uses to pass attributes to the footer's DOM element." - }, + } + ], + "methods": [] + }, + "CardPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ { - "name": "header", - "optional": true, + "name": "[key: string]", + "optional": false, "readonly": false, - "type": "CardPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the header's DOM element." - }, - { - "name": "root", - "optional": true, - "readonly": false, - "type": "CardPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the root's DOM element." - }, - { - "name": "subtitle", - "optional": true, - "readonly": false, - "type": "CardPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the subtitle's DOM element." - }, - { - "name": "title", - "optional": true, - "readonly": false, - "type": "CardPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the title's DOM element." + "type": "any" } ], "methods": [] @@ -4840,6 +4834,24 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "title", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom title template." + }, + { + "name": "subtitle", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom subtitle template." + }, { "name": "content", "parameters": [], @@ -4851,26 +4863,14 @@ "parameters": [], "returnType": "VNode[]", "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "subtitle", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom subtitle template." - }, - { - "name": "title", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom title template." } ] + }, + "CardEmits": { + "description": "Defines valid emits in Card component.", + "relatedProp": "", + "props": [], + "methods": [] } } }, @@ -4900,45 +4900,95 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "CarouselEmits": { - "description": "Defines valid emits in Carousel component.", + "CarouselResponsiveOptions": { "relatedProp": "", - "props": [], - "methods": [ + "props": [ { - "name": "update:page", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number", - "description": "New page value." - } - ], - "returnType": "void", - "description": "Emitted when the page changes." + "name": "breakpoint", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Breakpoint for responsive mode. Exp;" + }, + { + "name": "numVisible", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "The number of visible items on breakpoint." + }, + { + "name": "numScroll", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "The number of scrolled items on breakpoint." } - ] + ], + "methods": [] }, "CarouselProps": { "description": "Defines valid properties in Carousel component.", "relatedProp": "", "props": [ { - "name": "autoplayInterval", + "name": "value", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "An array of objects to display." + }, + { + "name": "page", "optional": true, "readonly": false, "type": "number", "default": "0", - "description": "Time in milliseconds to scroll items automatically." + "description": "Index of the first item." }, { - "name": "circular", + "name": "numVisible", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if scrolling would be infinite." + "type": "number", + "default": "1", + "description": "Number of items per page." + }, + { + "name": "numScroll", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Number of items to scroll." + }, + { + "name": "responsiveOptions", + "optional": true, + "readonly": false, + "type": "CarouselResponsiveOptions[]", + "default": "", + "description": "An array of options for responsive design." + }, + { + "name": "orientation", + "optional": true, + "readonly": false, + "type": "\"horizontal\" | \"vertical\"", + "default": "horizontal", + "description": "Specifies the layout of the component, valid values are 'horizontal' and 'vertical'." + }, + { + "name": "verticalViewPortHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "300px", + "description": "Height of the viewport in vertical layout." }, { "name": "containerClass", @@ -4965,68 +5015,20 @@ "description": "Style class of the indicator items." }, { - "name": "nextButtonProps", + "name": "circular", "optional": true, "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the next navigation button." + "type": "boolean", + "default": "false", + "description": "Defines if scrolling would be infinite." }, { - "name": "numScroll", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Number of items to scroll." - }, - { - "name": "numVisible", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Number of items per page." - }, - { - "name": "orientation", - "optional": true, - "readonly": false, - "type": "\"horizontal\" | \"vertical\"", - "default": "horizontal", - "description": "Specifies the layout of the component, valid values are 'horizontal' and 'vertical'." - }, - { - "name": "page", + "name": "autoplayInterval", "optional": true, "readonly": false, "type": "number", "default": "0", - "description": "Index of the first item." - }, - { - "name": "prevButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the previous navigation button." - }, - { - "name": "responsiveOptions", - "optional": true, - "readonly": false, - "type": "CarouselResponsiveOptions[]", - "default": "", - "description": "An array of options for responsive design." - }, - { - "name": "showIndicators", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to display indicator container." + "description": "Time in milliseconds to scroll items automatically." }, { "name": "showNavigators", @@ -5037,50 +5039,28 @@ "description": "Whether to display navigation buttons in container." }, { - "name": "value", + "name": "showIndicators", "optional": true, "readonly": false, - "type": "any", - "default": "", - "description": "An array of objects to display." + "type": "boolean", + "default": "true", + "description": "Whether to display indicator container." }, { - "name": "verticalViewPortHeight", + "name": "prevButtonProps", "optional": true, "readonly": false, - "type": "string", - "default": "300px", - "description": "Height of the viewport in vertical layout." - } - ], - "methods": [] - }, - "CarouselResponsiveOptions": { - "relatedProp": "", - "props": [ - { - "name": "breakpoint", - "optional": false, - "readonly": false, - "type": "string", + "type": "ButtonHTMLAttributes", "default": "", - "description": "Breakpoint for responsive mode. Exp;" + "description": "Uses to pass all properties of the HTMLButtonElement to the previous navigation button." }, { - "name": "numScroll", - "optional": false, + "name": "nextButtonProps", + "optional": true, "readonly": false, - "type": "number", + "type": "ButtonHTMLAttributes", "default": "", - "description": "The number of scrolled items on breakpoint." - }, - { - "name": "numVisible", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "The number of visible items on breakpoint." + "description": "Uses to pass all properties of the HTMLButtonElement to the next navigation button." } ], "methods": [] @@ -5090,18 +5070,6 @@ "relatedProp": "", "props": [], "methods": [ - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, { "name": "item", "parameters": [ @@ -5114,6 +5082,38 @@ ], "returnType": "VNode[]", "description": "Custom content for each item." + }, + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + } + ] + }, + "CarouselEmits": { + "description": "Defines valid emits in Carousel component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:page", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New page value." + } + ], + "returnType": "void", + "description": "Emitted when the page changes." } ] } @@ -5161,115 +5161,6 @@ "methods": [], "extendedBy": "CascadeSelectGroupChangeEvent" }, - "CascadeSelectEmits": { - "description": "Defines valid emits in CascadeSelect component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "before-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is hidden." - }, - { - "name": "before-show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is shown." - }, - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "CascadeSelectChangeEvent", - "description": "Custom change event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke on click." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "group-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "CascadeSelectGroupChangeEvent", - "description": "Custom change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a group changes." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is hidden." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is shown." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "CascadeSelectGroupChangeEvent": { "description": "", "relatedProp": "CascadeSelectEmits.change", @@ -5298,134 +5189,6 @@ "description": "Defines valid properties in CascadeSelect component.", "relatedProp": "", "props": [ - { - "name": "appendTo", - "optional": true, - "readonly": false, - "type": "string | HTMLElement", - "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." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "autoOptionFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "A property to uniquely identify an option." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "dropdownIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-down", - "description": "Icon to display in the dropdown." - }, - { - "name": "emptyMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No available options", - "description": "Text to be displayed when there are no options available. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptySearchMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptySelectionMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No selected item", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "loading", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the dropdown is in loading state." - }, - { - "name": "loadingIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-spinner pi-spin", - "description": "Icon to display in loading state." - }, { "name": "modelValue", "optional": true, @@ -5435,36 +5198,12 @@ "description": "Value of the component." }, { - "name": "optionDisabled", + "name": "options", "optional": true, "readonly": false, - "type": "string | Function", + "type": "any[]", "default": "", - "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." - }, - { - "name": "optionGroupChildren", - "optional": true, - "readonly": false, - "type": "string | string[] | Function", - "default": "", - "description": "Property name or getter function to retrieve the items of a group." - }, - { - "name": "optionGroupIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-angle-right", - "description": "Icon to display in the option group." - }, - { - "name": "optionGroupLabel", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the label of an option group." + "description": "An array of selectitems to display as the available options." }, { "name": "optionLabel", @@ -5483,12 +5222,92 @@ "description": "Property name or getter function to use as the value of an option, defaults to the option itself when not defined." }, { - "name": "options", + "name": "optionDisabled", "optional": true, "readonly": false, - "type": "any[]", + "type": "string | Function", "default": "", - "description": "An array of selectitems to display as the available options." + "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." + }, + { + "name": "optionGroupLabel", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function to use as the label of an option group." + }, + { + "name": "optionGroupChildren", + "optional": true, + "readonly": false, + "type": "string | string[] | Function", + "default": "", + "description": "Property name or getter function to retrieve the items of a group." + }, + { + "name": "placeholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Default text to display when no option is selected." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "A property to uniquely identify an option." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "panelStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the overlay panel." }, { "name": "panelClass", @@ -5507,20 +5326,60 @@ "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." }, { - "name": "panelStyle", + "name": "appendTo", "optional": true, "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the overlay panel." + "type": "string | HTMLElement", + "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." }, { - "name": "placeholder", + "name": "loading", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the dropdown is in loading state." + }, + { + "name": "dropdownIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Default text to display when no option is selected." + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." + }, + { + "name": "optionGroupIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-angle-right", + "description": "Icon to display in the option group." + }, + { + "name": "autoOptionFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." + }, + { + "name": "selectOnFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, the focused option is selected/opened." }, { "name": "searchLocale", @@ -5538,14 +5397,6 @@ "default": "'{0} results are available'", "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." }, - { - "name": "selectOnFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, the focused option is selected/opened." - }, { "name": "selectionMessage", "optional": true, @@ -5554,6 +5405,30 @@ "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, + { + "name": "emptySelectionMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No selected item", + "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptySearchMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found", + "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptyMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No available options", + "description": "Text to be displayed when there are no options available. Defaults to value from PrimeVue locale configuration." + }, { "name": "tabindex", "optional": true, @@ -5561,6 +5436,22 @@ "type": "string | number", "default": "", "description": "Index of the element in tabbing order." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." } ], "methods": [] @@ -5570,12 +5461,6 @@ "relatedProp": "", "props": [], "methods": [ - { - "name": "indicator", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom indicator template." - }, { "name": "option", "parameters": [ @@ -5595,12 +5480,127 @@ { "name": "scope", "optional": false, - "type": "{\n \t placeholder: string, // Placeholder text to show\n \t value: any, // Value of the component\n }", + "type": "{\n \t value: any, // Value of the component\n \t placeholder: string, // Placeholder text to show\n }", "description": "value slot's params." } ], "returnType": "VNode[]", "description": "Custom value template." + }, + { + "name": "indicator", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." + } + ] + }, + "CascadeSelectEmits": { + "description": "Defines valid emits in CascadeSelect component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "CascadeSelectChangeEvent", + "description": "Custom change event." + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on click." + }, + { + "name": "group-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "CascadeSelectGroupChangeEvent", + "description": "Custom change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a group changes." + }, + { + "name": "before-show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is shown." + }, + { + "name": "before-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is hidden." } ] } @@ -5615,18 +5615,6 @@ "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [ - { - "name": "generateLegend", - "parameters": [], - "returnType": "any", - "description": "Returns an HTML string of a legend for that chart. The legend is generated from the legendCallback in the options." - }, - { - "name": "getChart", - "parameters": [], - "returnType": "any", - "description": "Returns Chart instance." - }, { "name": "refresh", "parameters": [], @@ -5638,6 +5626,18 @@ "parameters": [], "returnType": "void", "description": "Destroys the graph first and then creates it again." + }, + { + "name": "generateLegend", + "parameters": [], + "returnType": "any", + "description": "Returns an HTML string of a legend for that chart. The legend is generated from the legendCallback in the options." + }, + { + "name": "getChart", + "parameters": [], + "returnType": "any", + "description": "Returns Chart instance." } ] } @@ -5649,50 +5649,48 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ChartEmits": { - "description": "Defines valid emits in Chart component.", - "relatedProp": "", - "props": [], - "methods": [ + "ChartSelectEvent": { + "description": "Custom select event.", + "relatedProp": "ChartEmits.select", + "props": [ { - "name": "loaded", - "parameters": [ - { - "name": "chart", - "optional": false, - "type": "any", - "description": "Chart instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when chart is loaded." + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." }, { - "name": "select", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "ChartSelectEvent", - "description": "Custom select event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a tab gets expanded." + "name": "element", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected element." + }, + { + "name": "dataset", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected dataset." } - ] + ], + "methods": [] }, "ChartProps": { "description": "Defines valid properties in Chart component.", "relatedProp": "", "props": [ { - "name": "canvasProps", + "name": "type", "optional": true, "readonly": false, - "type": "CanvasHTMLAttributes", + "type": "string", "default": "", - "description": "Uses to pass all properties of the CanvasHTMLAttributes to canvas element inside the component." + "description": "Type of the chart." }, { "name": "data", @@ -5702,14 +5700,6 @@ "default": "", "description": "Data to display." }, - { - "name": "height", - "optional": true, - "readonly": false, - "type": "number", - "default": "150", - "description": "Height of the chart in non-responsive mode." - }, { "name": "options", "optional": true, @@ -5726,14 +5716,6 @@ "default": "", "description": "Used to custom plugins of the chart." }, - { - "name": "type", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Type of the chart." - }, { "name": "width", "optional": true, @@ -5741,37 +5723,22 @@ "type": "number", "default": "300", "description": "Width of the chart in non-responsive mode." - } - ], - "methods": [] - }, - "ChartSelectEvent": { - "description": "Custom select event.", - "relatedProp": "ChartEmits.select", - "props": [ - { - "name": "dataset", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected dataset." }, { - "name": "element", - "optional": false, + "name": "height", + "optional": true, "readonly": false, - "type": "any", - "default": "", - "description": "Selected element." + "type": "number", + "default": "150", + "description": "Height of the chart in non-responsive mode." }, { - "name": "originalEvent", - "optional": false, + "name": "canvasProps", + "optional": true, "readonly": false, - "type": "Event", + "type": "CanvasHTMLAttributes", "default": "", - "description": "Browser event." + "description": "Uses to pass all properties of the CanvasHTMLAttributes to canvas element inside the component." } ], "methods": [] @@ -5780,6 +5747,39 @@ "relatedProp": "", "props": [], "methods": [] + }, + "ChartEmits": { + "description": "Defines valid emits in Chart component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "select", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "ChartSelectEvent", + "description": "Custom select event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a tab gets expanded." + }, + { + "name": "loaded", + "parameters": [ + { + "name": "chart", + "optional": false, + "type": "any", + "description": "Chart instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when chart is loaded." + } + ] } } } @@ -5801,140 +5801,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "CheckboxEmits": { - "description": "Defines valid emits in Checkbox component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "MouseEvent", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value click." - }, - { - "name": "input", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "update:page", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New page value." - } - ], - "returnType": "void", - "description": "Emitted when the page changes." - } - ] - }, "CheckboxProps": { "description": "Defines valid properties in Checkbox component.", "relatedProp": "", "props": [ { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "binary", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Allows to select a boolean value instead of multiple values." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "", - "description": "When present, it specifies that the element should be disabled." - }, - { - "name": "falseValue", + "name": "value", "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Value in unchecked state." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Inline style of the input field." + "description": "Value of the checkbox." }, { "name": "modelValue", @@ -5952,6 +5829,22 @@ "default": "", "description": "Name of the input element." }, + { + "name": "binary", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Allows to select a boolean value instead of multiple values." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "When present, it specifies that the element should be disabled." + }, { "name": "readonly", "optional": true, @@ -5985,12 +5878,60 @@ "description": "Value in checked state." }, { - "name": "value", + "name": "falseValue", "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Value of the checkbox." + "description": "Value in unchecked state." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." } ], "methods": [] @@ -5999,6 +5940,65 @@ "relatedProp": "", "props": [], "methods": [] + }, + "CheckboxEmits": { + "description": "Defines valid emits in Checkbox component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:page", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New page value." + } + ], + "returnType": "void", + "description": "Emitted when the page changes." + }, + { + "name": "click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "MouseEvent", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on value click." + }, + { + "name": "change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "input", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + } + ] } } } @@ -6020,30 +6020,18 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ChipEmits": { - "description": "Defines valid properties in Chip component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "remove", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a chip is removed." - } - ] - }, "ChipProps": { "description": "Defines valid properties in Chip component.", "relatedProp": "", "props": [ + { + "name": "label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines the text to display." + }, { "name": "icon", "optional": true, @@ -6060,14 +6048,6 @@ "default": "", "description": "Defines the image to display." }, - { - "name": "label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines the text to display." - }, { "name": "removable", "optional": true, @@ -6099,6 +6079,26 @@ "description": "Content can easily be customized with the default slot instead of using the built-in modes." } ] + }, + "ChipEmits": { + "description": "Defines valid properties in Chip component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "remove", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a chip is removed." + } + ] } } } @@ -6144,11 +6144,187 @@ "methods": [], "extendedBy": "ChipsRemoveEvent" }, + "ChipsRemoveEvent": { + "description": "Custom remove event.", + "relatedProp": "ChipsEmits.remove", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Added/Removed item value." + } + ], + "methods": [], + "extendedTypes": "ChipsAddEvent" + }, + "ChipsProps": { + "description": "Defines valid properties in Chips component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Value of the component." + }, + { + "name": "max", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Maximum number of entries allowed." + }, + { + "name": "addOnBlur", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to add an item when the input loses focus." + }, + { + "name": "allowDuplicate", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to allow duplicate values or not." + }, + { + "name": "separator", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Separator char to add an item when pressed in addition to the enter key." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the focus input to match a label defined for the chips." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "removeTokenIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times-circle", + "description": "Icon to display in chip remove action." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "When present, it specifies that the element should be disabled." + }, + { + "name": "placeholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Placeholder text for the input." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." + } + ], + "methods": [] + }, + "ChipsSlots": { + "description": "Defines valid slots in Chips slots.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "chip", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n }", + "description": "chip slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom chip template." + } + ] + }, "ChipsEmits": { "description": "Defines valid emits in Chips component.", "relatedProp": "", "props": [], "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, { "name": "add", "parameters": [ @@ -6174,182 +6350,6 @@ ], "returnType": "void", "description": "Callback to invoke when a chip is removed." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any[]", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, - "ChipsProps": { - "description": "Defines valid properties in Chips component.", - "relatedProp": "", - "props": [ - { - "name": "addOnBlur", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to add an item when the input loses focus." - }, - { - "name": "allowDuplicate", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to allow duplicate values or not." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "", - "description": "When present, it specifies that the element should be disabled." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the focus input to match a label defined for the chips." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "max", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Maximum number of entries allowed." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Value of the component." - }, - { - "name": "placeholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text for the input." - }, - { - "name": "removeTokenIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times-circle", - "description": "Icon to display in chip remove action." - }, - { - "name": "separator", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Separator char to add an item when pressed in addition to the enter key." - } - ], - "methods": [] - }, - "ChipsRemoveEvent": { - "description": "Custom remove event.", - "relatedProp": "ChipsEmits.remove", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Added/Removed item value." - } - ], - "methods": [], - "extendedTypes": "ChipsAddEvent" - }, - "ChipsSlots": { - "description": "Defines valid slots in Chips slots.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "chip", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t value: any, // Value of the component\n }", - "description": "chip slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom chip template." } ] } @@ -6396,62 +6396,57 @@ ], "methods": [] }, - "ColorPickerEmits": { - "description": "Defines valid emits in ColorPicker component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "ColorPickerChangeEvent", - "description": "Custom add event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a chip is added." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when input is cleared by the user." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when input is cleared by the user." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "ColorPickerProps": { "description": "Defines valid properties in ColorPicker component.", "relatedProp": "", "props": [ { - "name": "appendTo", + "name": "modelValue", "optional": true, "readonly": false, - "type": "string | HTMLElement", - "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." + "type": "any", + "default": "", + "description": "Value of the component." + }, + { + "name": "defaultColor", + "optional": true, + "readonly": false, + "type": "any", + "default": "ff0000", + "description": "Initial color to display when value is not defined." + }, + { + "name": "inline", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to display as an overlay or not." + }, + { + "name": "format", + "optional": true, + "readonly": false, + "type": "\"rgb\" | \"hex\" | \"hsb\"", + "default": "hex", + "description": "Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Index of the element in tabbing order." }, { "name": "autoZIndex", @@ -6469,46 +6464,6 @@ "default": "0", "description": "Base zIndex value to use in layering." }, - { - "name": "defaultColor", - "optional": true, - "readonly": false, - "type": "any", - "default": "ff0000", - "description": "Initial color to display when value is not defined." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "format", - "optional": true, - "readonly": false, - "type": "\"rgb\" | \"hex\" | \"hsb\"", - "default": "hex", - "description": "Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'." - }, - { - "name": "inline", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to display as an overlay or not." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Value of the component." - }, { "name": "panelClass", "optional": true, @@ -6518,12 +6473,12 @@ "description": "Style class of the overlay panel." }, { - "name": "tabindex", + "name": "appendTo", "optional": true, "readonly": false, - "type": "string", - "default": "", - "description": "Index of the element in tabbing order." + "type": "string | HTMLElement", + "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." } ], "methods": [] @@ -6532,6 +6487,51 @@ "relatedProp": "", "props": [], "methods": [] + }, + "ColorPickerEmits": { + "description": "Defines valid emits in ColorPicker component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "ColorPickerChangeEvent", + "description": "Custom add event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a chip is added." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when input is cleared by the user." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when input is cleared by the user." + } + ] } } } @@ -6553,9 +6553,27 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ColumnEmits": { + "ColumnFilterModelType": { + "description": "Filter model metadata.", "relatedProp": "", - "props": [], + "props": [ + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Value of filterModel." + }, + { + "name": "matchMode", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Match mode of filterModel." + } + ], "methods": [] }, "ColumnFilterMatchModeOptions": { @@ -6571,40 +6589,17 @@ ], "methods": [] }, - "ColumnFilterModelType": { - "description": "Filter model metadata.", - "relatedProp": "", - "props": [ - { - "name": "matchMode", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Match mode of filterModel." - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Value of filterModel." - } - ], - "methods": [] - }, "ColumnLoadingOptions": { "description": "Custom column loading metadata.", "relatedProp": "", "props": [ { - "name": "cellEven", + "name": "cellIndex", "optional": false, "readonly": false, - "type": "boolean", + "type": "number", "default": "", - "description": "Whether the cell is even." + "description": "Cell index" }, { "name": "cellFirst", @@ -6614,14 +6609,6 @@ "default": "", "description": "Whether the cell is first." }, - { - "name": "cellIndex", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Cell index" - }, { "name": "cellLast", "optional": false, @@ -6630,6 +6617,14 @@ "default": "", "description": "Whether the cell is last." }, + { + "name": "cellEven", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the cell is even." + }, { "name": "cellOdd", "optional": false, @@ -6646,22 +6641,6 @@ "default": "", "description": "Column instance" }, - { - "name": "count", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Items count" - }, - { - "name": "even", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is even." - }, { "name": "field", "optional": false, @@ -6670,14 +6649,6 @@ "default": "", "description": "Column field" }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is first." - }, { "name": "index", "optional": false, @@ -6686,6 +6657,22 @@ "default": "", "description": "Item index" }, + { + "name": "count", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Items count" + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is first." + }, { "name": "last", "optional": false, @@ -6694,6 +6681,14 @@ "default": "", "description": "Whether the item is last." }, + { + "name": "even", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is even." + }, { "name": "odd", "optional": false, @@ -6710,46 +6705,6 @@ "description": "Defines valid properties in Column component.", "relatedProp": "", "props": [ - { - "name": "alignFrozen", - "optional": true, - "readonly": false, - "type": "\"left\" | \"right\"", - "default": "left", - "description": "Position of a frozen column, valid values are left and right." - }, - { - "name": "bodyClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the column body." - }, - { - "name": "bodyStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the column body." - }, - { - "name": "class", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of header, body and footer cells." - }, - { - "name": "colspan", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of columns to span for grouping." - }, { "name": "columnKey", "optional": true, @@ -6758,54 +6713,6 @@ "default": "", "description": "Identifier of a column if field property is not defined." }, - { - "name": "dataType", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Type of data. It's value is related to PrimeVue.filterMatchModeOptions config." - }, - { - "name": "excludeGlobalFilter", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to exclude from global filtering or not." - }, - { - "name": "expander", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Displays an icon to toggle row expansion." - }, - { - "name": "exportFooter", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Custom export footer of the column to be exported as CSV." - }, - { - "name": "exportHeader", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Custom export header of the column to be exported as CSV." - }, - { - "name": "exportable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the column is included in data export." - }, { "name": "field", "optional": true, @@ -6814,6 +6721,14 @@ "default": "", "description": "Property represented by the column." }, + { + "name": "sortField", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name to use in sorting, defaults to field." + }, { "name": "filterField", "optional": true, @@ -6823,84 +6738,20 @@ "description": "Property name to use in filtering, defaults to field." }, { - "name": "filterHeaderClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the column filter header in row filter display." - }, - { - "name": "filterHeaderStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the column filter header in row filter display." - }, - { - "name": "filterMatchMode", + "name": "dataType", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Defines the filtering algorithm to use when searching the options." + "description": "Type of data. It's value is related to PrimeVue.filterMatchModeOptions config." }, { - "name": "filterMatchModeOptions", - "optional": true, - "readonly": false, - "type": "ColumnFilterMatchModeOptions[]", - "default": "", - "description": "An array of label-value pairs to override the global match mode options." - }, - { - "name": "filterMenuClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the column filter overlay." - }, - { - "name": "filterMenuStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the column filter overlay." - }, - { - "name": "footer", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Footer content of the column." - }, - { - "name": "footerClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the column footer." - }, - { - "name": "footerStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the column footer." - }, - { - "name": "frozen", + "name": "sortable", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Whether the column is fixed in horizontal scrolling." + "description": "Defines if a column is sortable." }, { "name": "header", @@ -6911,12 +6762,28 @@ "description": "Header content of the column." }, { - "name": "headerClass", + "name": "footer", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Footer content of the column." + }, + { + "name": "style", "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Style class of the column header." + "description": "Inline style of header, body and footer cells." + }, + { + "name": "class", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of header, body and footer cells." }, { "name": "headerStyle", @@ -6927,100 +6794,44 @@ "description": "Inline style of the column header." }, { - "name": "hidden", + "name": "headerClass", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the column is rendered." - }, - { - "name": "maxConstraints", - "optional": true, - "readonly": false, - "type": "number", - "default": "2", - "description": "Maximum number of constraints for a column filter." - }, - { - "name": "reorderableColumn", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if the column itself can be reordered with dragging." - }, - { - "name": "rowEditor", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, column displays row editor controls." - }, - { - "name": "rowReorder", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether this column displays an icon to reorder the rows." - }, - { - "name": "rowReorderIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-bars", - "description": "Icon of the drag handle to reorder rows." - }, - { - "name": "rowspan", - "optional": true, - "readonly": false, - "type": "number", + "type": "any", "default": "", - "description": "Number of rows to span for grouping." + "description": "Style class of the column header." }, { - "name": "selectionMode", + "name": "bodyStyle", "optional": true, "readonly": false, - "type": "\"multiple\" | \"single\"", + "type": "any", "default": "", - "description": "Defines column based selection mode." + "description": "Inline style of the column body." }, { - "name": "showAddButton", + "name": "bodyClass", "optional": true, "readonly": false, - "type": "boolean", - "default": "true", - "description": "When enabled, a button is displayed to add more rules." + "type": "any", + "default": "", + "description": "Style class of the column body." }, { - "name": "showApplyButton", + "name": "footerStyle", "optional": true, "readonly": false, - "type": "boolean", - "default": "true", - "description": "Displays a button to apply the column filtering." + "type": "any", + "default": "", + "description": "Inline style of the column footer." }, { - "name": "showClearButton", + "name": "footerClass", "optional": true, "readonly": false, - "type": "boolean", - "default": "true", - "description": "Displays a button to clear the column filtering." - }, - { - "name": "showFilterMatchModes", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show the match modes selector." + "type": "any", + "default": "", + "description": "Style class of the column footer." }, { "name": "showFilterMenu", @@ -7039,28 +6850,212 @@ "description": "When enabled, match all and match any operator selector is displayed." }, { - "name": "sortField", + "name": "showClearButton", "optional": true, "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name to use in sorting, defaults to field." + "type": "boolean", + "default": "true", + "description": "Displays a button to clear the column filtering." }, { - "name": "sortable", + "name": "showApplyButton", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Displays a button to apply the column filtering." + }, + { + "name": "showFilterMatchModes", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show the match modes selector." + }, + { + "name": "showAddButton", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "When enabled, a button is displayed to add more rules." + }, + { + "name": "filterMatchModeOptions", + "optional": true, + "readonly": false, + "type": "ColumnFilterMatchModeOptions[]", + "default": "", + "description": "An array of label-value pairs to override the global match mode options." + }, + { + "name": "maxConstraints", + "optional": true, + "readonly": false, + "type": "number", + "default": "2", + "description": "Maximum number of constraints for a column filter." + }, + { + "name": "excludeGlobalFilter", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Defines if a column is sortable." + "description": "Whether to exclude from global filtering or not." }, { - "name": "style", + "name": "filterHeaderStyle", "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Inline style of header, body and footer cells." + "description": "Inline style of the column filter header in row filter display." + }, + { + "name": "filterHeaderClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the column filter header in row filter display." + }, + { + "name": "filterMenuStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the column filter overlay." + }, + { + "name": "filterMenuClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the column filter overlay." + }, + { + "name": "selectionMode", + "optional": true, + "readonly": false, + "type": "\"multiple\" | \"single\"", + "default": "", + "description": "Defines column based selection mode." + }, + { + "name": "expander", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Displays an icon to toggle row expansion." + }, + { + "name": "colspan", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of columns to span for grouping." + }, + { + "name": "rowspan", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to span for grouping." + }, + { + "name": "rowReorder", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether this column displays an icon to reorder the rows." + }, + { + "name": "rowReorderIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-bars", + "description": "Icon of the drag handle to reorder rows." + }, + { + "name": "reorderableColumn", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if the column itself can be reordered with dragging." + }, + { + "name": "rowEditor", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, column displays row editor controls." + }, + { + "name": "frozen", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the column is fixed in horizontal scrolling." + }, + { + "name": "alignFrozen", + "optional": true, + "readonly": false, + "type": "\"left\" | \"right\"", + "default": "left", + "description": "Position of a frozen column, valid values are left and right." + }, + { + "name": "exportable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the column is included in data export." + }, + { + "name": "exportHeader", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Custom export header of the column to be exported as CSV." + }, + { + "name": "exportFooter", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Custom export footer of the column to be exported as CSV." + }, + { + "name": "filterMatchMode", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines the filtering algorithm to use when searching the options." + }, + { + "name": "hidden", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the column is rendered." } ], "methods": [] @@ -7076,20 +7071,46 @@ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t node: any, // Row node data.\n \t editorInitCallback(): void, // Callback function\n }", + "type": "{\n \t data: any, // Row data.\n \t node: any, // Row node data.\n \t column: Column, // Column node.\n \t field: string, // Column field.\n \t index: number, // Row index.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t editorInitCallback(): void, // Callback function\n }", "description": "body slot's params." } ], "returnType": "VNode[]", "description": "Custom body template." }, + { + "name": "header", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t column: Column, // Column node.\n }", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t column: Column, // Column node.\n }", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template." + }, { "name": "editor", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t editorCancelCallback(): void, // Callback function\n \t editorSaveCallback(): void, // Callback function\n }", + "type": "{\n \t data: any, // Row data.\n \t column: Column, // Column node.\n \t field: string, // Column field.\n \t index: number, // Row index.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t editorSaveCallback(): void, // Callback function\n \t editorCancelCallback(): void, // Callback function\n }", "description": "editor slot's params." } ], @@ -7110,30 +7131,17 @@ "description": "Custom filter template." }, { - "name": "filterapply", + "name": "filterheader", "parameters": [ { "name": "scope", "optional": false, "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }", - "description": "filter apply slot's params." + "description": "filter header slot's params." } ], "returnType": "VNode[]", - "description": "Custom filter apply template." - }, - { - "name": "filterclear", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }", - "description": "filter clear slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom filter clear template." + "description": "Custom filter header template." }, { "name": "filterfooter", @@ -7149,43 +7157,30 @@ "description": "Custom filter footer template." }, { - "name": "filterheader", + "name": "filterclear", "parameters": [ { "name": "scope", "optional": false, "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }", - "description": "filter header slot's params." + "description": "filter clear slot's params." } ], "returnType": "VNode[]", - "description": "Custom filter header template." + "description": "Custom filter clear template." }, { - "name": "footer", + "name": "filterapply", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n }", - "description": "footer slot's params." + "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }", + "description": "filter apply slot's params." } ], "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t column: Column, // Column node.\n }", - "description": "header slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom header template." + "description": "Custom filter apply template." }, { "name": "loading", @@ -7193,7 +7188,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t loadingOptions: ColumnLoadingOptions, // Loading options.\n }", + "type": "{\n \t data: any, // Row data.\n \t column: Column, // Column node.\n \t field: string, // Column field.\n \t index: number, // Row index.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t loadingOptions: ColumnLoadingOptions, // Loading options.\n }", "description": "loading slot's params." } ], @@ -7201,6 +7196,11 @@ "description": "Custom loading template." } ] + }, + "ColumnEmits": { + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -7222,12 +7222,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ColumnGroupEmits": { - "description": "Defines valid emits in ColumnGroup component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "ColumnGroupProps": { "description": "Defines valid properties in ColumnGroup component.", "relatedProp": "", @@ -7248,6 +7242,12 @@ "relatedProp": "", "props": [], "methods": [] + }, + "ColumnGroupEmits": { + "description": "Defines valid emits in ColumnGroup component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -7277,59 +7277,12 @@ "relatedProp": "", "props": [ { - "name": "accept", + "name": "target", "optional": true, "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "acceptClass", - "optional": true, - "readonly": false, - "type": "string", + "type": "HTMLElement", "default": "", - "description": "Style class of the accept button." - }, - { - "name": "acceptIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Icon of the accept button." - }, - { - "name": "acceptLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Label of the accept button. Defaults to PrimeVue Locale configuration." - }, - { - "name": "blockScroll", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether background scroll should be blocked when dialog is visible." - }, - { - "name": "defaultFocus", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Element to receive the focus when the dialog gets visible, valid values are \"accept\" and \"reject\"." - }, - { - "name": "group", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance." + "description": "Element to align the overlay." }, { "name": "header", @@ -7339,14 +7292,6 @@ "default": "", "description": "Header text of the dialog." }, - { - "name": "icon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Icon to display next to the message." - }, { "name": "message", "optional": true, @@ -7356,11 +7301,12 @@ "description": "Message of the confirmation." }, { - "name": "onHide", + "name": "group", "optional": true, "readonly": false, - "type": "Function", - "default": "" + "type": "string", + "default": "", + "description": "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance." }, { "name": "position", @@ -7371,20 +7317,42 @@ "description": "Position of the dialog." }, { - "name": "rejectClass", + "name": "icon", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Style class of the reject button." + "description": "Icon to display next to the message." }, { - "name": "rejectIcon", + "name": "blockScroll", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether background scroll should be blocked when dialog is visible." + }, + { + "name": "accept", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "onHide", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "acceptLabel", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Icon of the reject button." + "description": "Label of the accept button. Defaults to PrimeVue Locale configuration." }, { "name": "rejectLabel", @@ -7395,12 +7363,44 @@ "description": "Label of the reject button. Defaults to PrimeVue Locale configuration." }, { - "name": "target", + "name": "acceptIcon", "optional": true, "readonly": false, - "type": "HTMLElement", + "type": "string", "default": "", - "description": "Element to align the overlay." + "description": "Icon of the accept button." + }, + { + "name": "rejectIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Icon of the reject button." + }, + { + "name": "acceptClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the accept button." + }, + { + "name": "rejectClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the reject button." + }, + { + "name": "defaultFocus", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Element to receive the focus when the dialog gets visible, valid values are \"accept\" and \"reject\"." } ], "methods": [ @@ -7427,12 +7427,6 @@ "methods": { "description": "", "values": [ - { - "name": "close", - "parameters": [], - "returnType": "void", - "description": "Hides the dialog without invoking accept or reject callbacks." - }, { "name": "require", "parameters": [ @@ -7445,6 +7439,12 @@ ], "returnType": "void", "description": "Displays the dialog using the confirmation object options." + }, + { + "name": "close", + "parameters": [], + "returnType": "void", + "description": "Hides the dialog without invoking accept or reject callbacks." } ] } @@ -7481,16 +7481,18 @@ ], "methods": [] }, - "ConfirmDialogEmits": { - "description": "Defines valid emits in ConfirmDialog component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "ConfirmDialogProps": { "description": "Defines valid properties in ConfirmDialog component.", "relatedProp": "", "props": [ + { + "name": "group", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance." + }, { "name": "breakpoints", "optional": true, @@ -7506,14 +7508,6 @@ "type": "boolean", "default": "true", "description": "Enables dragging to change the position using header." - }, - { - "name": "group", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance." } ], "methods": [] @@ -7537,6 +7531,12 @@ "description": "Custom message template." } ] + }, + "ConfirmDialogEmits": { + "description": "Defines valid emits in ConfirmDialog component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -7558,12 +7558,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ConfirmPopupEmits": { - "description": "Defines valid emits in ConfirmPopup component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "ConfirmPopupProps": { "description": "Defines valid properties in ConfirmPopup component.", "relatedProp": "", @@ -7598,6 +7592,12 @@ "description": "Custom message template." } ] + }, + "ConfirmPopupEmits": { + "description": "Defines valid emits in ConfirmPopup component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -7611,10 +7611,16 @@ "description": "Defines methods that can be accessed by the component's reference.", "values": [ { - "name": "hide", - "parameters": [], + "name": "toggle", + "parameters": [ + { + "name": "event", + "type": "Event", + "description": "Browser event." + } + ], "returnType": "void", - "description": "Hides the menu." + "description": "Toggles the visibility of the menu." }, { "name": "show", @@ -7629,16 +7635,10 @@ "description": "Shows the menu." }, { - "name": "toggle", - "parameters": [ - { - "name": "event", - "type": "Event", - "description": "Browser event." - } - ], + "name": "hide", + "parameters": [], "returnType": "void", - "description": "Toggles the visibility of the menu." + "description": "Hides the menu." } ] } @@ -7650,67 +7650,18 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ContextMenuEmits": { - "description": "Defines valid emits in ContextMenu component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "before-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the popup is hidden." - }, - { - "name": "before-show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the popup is shown." - }, - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the popup is hidden." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the popup is shown." - } - ] - }, "ContextMenuProps": { "description": "Defines valid properties in ContextMenu component.", "relatedProp": "", "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "An array of menuitems." + }, { "name": "appendTo", "optional": true, @@ -7719,22 +7670,6 @@ "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying menu element." - }, { "name": "autoZIndex", "optional": true, @@ -7751,14 +7686,6 @@ "default": "0", "description": "Base zIndex value to use in layering." }, - { - "name": "exact", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." - }, { "name": "global", "optional": true, @@ -7768,12 +7695,12 @@ "description": "Attaches the menu to document instead of a particular item." }, { - "name": "model", + "name": "exact", "optional": true, "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "An array of menuitems." + "type": "boolean", + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "tabindex", @@ -7782,6 +7709,22 @@ "type": "string | number", "default": "", "description": "Index of the element in tabbing order." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying menu element." } ], "methods": [] @@ -7805,6 +7748,63 @@ "description": "Custom item template." } ] + }, + "ContextMenuEmits": { + "description": "Defines valid emits in ContextMenu component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "before-show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the popup is shown." + }, + { + "name": "before-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the popup is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the popup is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the popup is hidden." + } + ] } } } @@ -7844,9 +7844,9 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "DataTableCellEditCancelEvent": { - "description": "Custom cell edit cancel event.", - "relatedProp": "DataTableEmits['cell-edit-cancel']", + "DataTableExportFunctionOptions": { + "description": "Custom datatable export metadata.", + "relatedProp": "", "props": [ { "name": "data", @@ -7854,7 +7854,7 @@ "readonly": false, "type": "any", "default": "", - "description": "Row data to edit." + "description": "Row data" }, { "name": "field", @@ -7862,189 +7862,102 @@ "readonly": false, "type": "string", "default": "", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the row data to edit." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" + "description": "Column Field" } ], - "methods": [], - "extendedTypes": "DataTableCellEditInitEvent" + "methods": [] }, - "DataTableCellEditCompleteEvent": { - "description": "Custom cell edit complete event.", - "relatedProp": "DataTableEmits['cell-edit-complete']", + "DataTableFilterMetaData": { + "description": "Custom datatable filter metadata.", + "relatedProp": "", "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Row data to edit." - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the row data to edit." - }, - { - "name": "newData", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "New row data after editing." - }, - { - "name": "newValue", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Field value of new row data after editing." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "type", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Type of completion such as 'enter', 'outside' or 'tab'." - }, { "name": "value", "optional": false, "readonly": false, "type": "any", "default": "", - "description": "Field value of row data to edit." + "description": "Filter value" + }, + { + "name": "matchMode", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Filter match mode" } ], "methods": [] }, - "DataTableCellEditInitEvent": { - "description": "Custom cell edit init event.", - "relatedProp": "DataTableEmits['cell-edit-init']", + "DataTableOperatorFilterMetaData": { + "description": "Custom datatable operator filter metadata.", + "relatedProp": "", "props": [ { - "name": "data", + "name": "operator", "optional": false, "readonly": false, - "type": "any", + "type": "string", "default": "", - "description": "Row data to edit." + "description": "Filter operator" }, + { + "name": "constraints", + "optional": false, + "readonly": false, + "type": "DataTableFilterMetaData[]", + "default": "", + "description": "Array of filter meta datas." + } + ], + "methods": [] + }, + "DataTableFilterMeta": { + "description": "Custom datatable filter metadata.", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "string | DataTableFilterMetaData | DataTableOperatorFilterMetaData" + } + ], + "methods": [] + }, + "DataTableSortMeta": { + "description": "Custom datatable sort meta.", + "relatedProp": "", + "props": [ { "name": "field", "optional": false, "readonly": false, "type": "string", "default": "", - "description": "Field name of the row data." + "description": "Column field" }, { - "name": "index", + "name": "order", "optional": false, "readonly": false, - "type": "number", + "type": "undefined | null | 0 | 1 | -1", "default": "", - "description": "Index of the row data to edit." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedBy": "DataTableCellEditCancelEvent" - }, - "DataTableColumnReorderEvent": { - "description": "Custom row column reorder event.", - "relatedProp": "DataTableEmits['column-reorder']", - "props": [ - { - "name": "dragIndex", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the dragged column" - }, - { - "name": "dropIndex", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the dropped column" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" + "description": "Column sort order" } ], "methods": [] }, - "DataTableColumnResizeEndEvent": { - "description": "Custom column resize end event.", - "relatedProp": "DataTableEmits['column-resize-end']", + "DataTableExpandedRows": { + "description": "Custom datatable expanded rows.", + "relatedProp": "", "props": [ { - "name": "delta", + "name": "[key: string]", "optional": false, "readonly": false, - "type": "any", - "default": "", - "description": "Change in column width" - }, - { - "name": "element", - "optional": false, - "readonly": false, - "type": "HTMLElement", - "default": "", - "description": "DOM element of the resized column." + "type": "boolean" } ], "methods": [] @@ -8062,413 +7975,1645 @@ ], "methods": [] }, + "DataTableExportCSVOptions": { + "description": "Custom datatable export csv metadata.", + "relatedProp": "", + "props": [ + { + "name": "selectionOnly", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether to export only selection data." + } + ], + "methods": [] + }, + "DataTableSortEvent": { + "description": "Custom sort event.", + "relatedProp": "DataTableEmits.sort", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "undefined | string | Function", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | DataTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "DataTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "filterMatchModes", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Match modes per field" + } + ], + "methods": [], + "extendedBy": "DataTablePageEvent,DataTableFilterEvent" + }, + "DataTablePageEvent": { + "description": "Custom pagination event.", + "relatedProp": "DataTableEmits.page", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "undefined | string | Function", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | DataTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "DataTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "filterMatchModes", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Match modes per field" + }, + { + "name": "page", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "New page number" + }, + { + "name": "pageCount", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Total page count" + } + ], + "methods": [], + "extendedTypes": "DataTableSortEvent" + }, + "DataTableFilterEvent": { + "description": "Custom filter event.", + "relatedProp": "DataTableEmits.filter", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "undefined | string | Function", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | DataTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "DataTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "filterMatchModes", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Match modes per field" + }, + { + "name": "filteredValue", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Filtered collection (non-lazy only)" + } + ], + "methods": [], + "extendedTypes": "DataTableSortEvent" + }, + "DataTableRowClickEvent": { + "description": "Custom row click event.", + "relatedProp": "DataTableEmits['row-click']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Row index." + } + ], + "methods": [], + "extendedBy": "DataTableRowDoubleClickEvent,DataTableRowContextMenuEvent" + }, + "DataTableRowDoubleClickEvent": { + "description": "Custom row double click event.", + "relatedProp": "DataTableEmits['row-dblclick']]", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Row index." + } + ], + "methods": [], + "extendedTypes": "DataTableRowClickEvent" + }, + "DataTableRowContextMenuEvent": { + "description": "Custom row context menu event.", + "relatedProp": "DataTableEmits['row-contextmenu']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Row index." + } + ], + "methods": [], + "extendedTypes": "DataTableRowClickEvent" + }, + "DataTableRowSelectEvent": { + "description": "Custom row select event.", + "relatedProp": "DataTableEmits['row-select']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row data" + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Row index" + }, + { + "name": "type", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Type of the selection, valid values are 'row', 'radio' or 'checkbox'." + } + ], + "methods": [], + "extendedBy": "DataTableRowUnselectEvent" + }, + "DataTableRowUnselectEvent": { + "description": "Custom row unselect event.", + "relatedProp": "DataTableEmits['row-unselect']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row data" + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Row index" + }, + { + "name": "type", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Type of the selection, valid values are 'row', 'radio' or 'checkbox'." + } + ], + "methods": [], + "extendedTypes": "DataTableRowSelectEvent" + }, + "DataTableRowSelectAllEvent": { + "description": "Custom row select all event.", + "relatedProp": "DataTableEmits['row-select-all']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected dataset" + } + ], + "methods": [] + }, + "DataTableRowUnselectAllEvent": { + "description": "Custom row unselect all event.", + "relatedProp": "DataTableEmits['row-unselect-all']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [] + }, + "DataTableSelectAllChangeEvent": { + "description": "Custom row select all change event.", + "relatedProp": "DataTableEmits['select-all-change']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "checked", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether all data is selected." + } + ], + "methods": [] + }, + "DataTableColumnResizeEndEvent": { + "description": "Custom column resize end event.", + "relatedProp": "DataTableEmits['column-resize-end']", + "props": [ + { + "name": "element", + "optional": false, + "readonly": false, + "type": "HTMLElement", + "default": "", + "description": "DOM element of the resized column." + }, + { + "name": "delta", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Change in column width" + } + ], + "methods": [] + }, + "DataTableColumnReorderEvent": { + "description": "Custom row column reorder event.", + "relatedProp": "DataTableEmits['column-reorder']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "dragIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dragged column" + }, + { + "name": "dropIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dropped column" + } + ], + "methods": [] + }, + "DataTableRowReorderEvent": { + "description": "Custom row reorder event.", + "relatedProp": "DataTableEmits['row-reorder']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "dragIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dragged row" + }, + { + "name": "dropIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dropped row" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Reordered value" + } + ], + "methods": [] + }, + "DataTableRowExpandEvent": { + "description": "Custom row expand event.", + "relatedProp": "DataTableEmits['row-expand']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Expanded row data" + } + ], + "methods": [], + "extendedBy": "DataTableRowCollapseEvent" + }, + "DataTableRowCollapseEvent": { + "description": "Custom row collapse event.", + "relatedProp": "DataTableEmits['row-expand']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Expanded row data" + } + ], + "methods": [], + "extendedTypes": "DataTableRowExpandEvent" + }, + "DataTableCellEditInitEvent": { + "description": "Custom cell edit init event.", + "relatedProp": "DataTableEmits['cell-edit-init']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + } + ], + "methods": [], + "extendedBy": "DataTableCellEditCancelEvent" + }, + "DataTableCellEditCancelEvent": { + "description": "Custom cell edit cancel event.", + "relatedProp": "DataTableEmits['cell-edit-cancel']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + } + ], + "methods": [], + "extendedTypes": "DataTableCellEditInitEvent" + }, + "DataTableCellEditCompleteEvent": { + "description": "Custom cell edit complete event.", + "relatedProp": "DataTableEmits['cell-edit-complete']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "newData", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "New row data after editing." + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Field value of row data to edit." + }, + { + "name": "newValue", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Field value of new row data after editing." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + }, + { + "name": "type", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Type of completion such as 'enter', 'outside' or 'tab'." + } + ], + "methods": [] + }, + "DataTableRowEditInitEvent": { + "description": "Custom row edit init event.", + "relatedProp": "DataTableEmits['row-edit-init']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "newData", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "New row data after editing." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + } + ], + "methods": [], + "extendedBy": "DataTableRowEditSaveEvent,DataTableRowEditCancelEvent" + }, + "DataTableRowEditSaveEvent": { + "description": "Custom row edit save event.", + "relatedProp": "DataTableEmits['row-edit-save']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "newData", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "New row data after editing." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + } + ], + "methods": [], + "extendedTypes": "DataTableRowEditInitEvent" + }, + "DataTableRowEditCancelEvent": { + "description": "Custom row edit cancel event.", + "relatedProp": "DataTableEmits['row-edit-cancel']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "newData", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "New row data after editing." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + } + ], + "methods": [], + "extendedTypes": "DataTableRowEditInitEvent" + }, + "DataTableStateEvent": { + "description": "Custom state event.", + "relatedProp": "DataTableEmits['state-save']", + "props": [ + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | DataTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "DataTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "columWidths", + "optional": false, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Comma separated list of column widths" + }, + { + "name": "columnOrder", + "optional": false, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Order of the columns" + }, + { + "name": "expandedRows", + "optional": false, + "readonly": false, + "type": "any[] | DataTableExpandedRows", + "default": "", + "description": "Instances of rows in expanded state" + }, + { + "name": "expandedRowKeys", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Keys of rows in expanded state" + }, + { + "name": "expandedRowGroups", + "optional": false, + "readonly": false, + "type": "any[] | DataTableExpandedRows", + "default": "", + "description": "Instances of rows in expanded state" + }, + { + "name": "selection", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected rows" + }, + { + "name": "selectionKeys", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Keys of selected rows" + } + ], + "methods": [] + }, + "DataTableProps": { + "description": "Defines valid properties in DataTable component.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "null | any[]", + "default": "", + "description": "An array of objects to display." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Name of the field that uniquely identifies the a record in the data." + }, + { + "name": "rows", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Number of rows to display per page." + }, + { + "name": "first", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Index of the first row to be displayed." + }, + { + "name": "totalRecords", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Number of total records, defaults to length of value when not defined." + }, + { + "name": "paginator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified as true, enables the pagination." + }, + { + "name": "paginatorPosition", + "optional": true, + "readonly": false, + "type": "\"both\" | \"top\" | \"bottom\"", + "default": "bottom", + "description": "Position of the paginator, options are 'top','bottom' or 'both'." + }, + { + "name": "alwaysShowPaginator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show it even there is only one page." + }, + { + "name": "paginatorTemplate", + "optional": true, + "readonly": false, + "type": "any", + "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", + "description": "Template of the paginator. It can be customized using the template property using the predefined keys.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" + }, + { + "name": "pageLinkSize", + "optional": true, + "readonly": false, + "type": "number", + "default": "5", + "description": "Number of page links to display." + }, + { + "name": "rowsPerPageOptions", + "optional": true, + "readonly": false, + "type": "number[]", + "default": "", + "description": "Array of integer values to display inside rows per page dropdown." + }, + { + "name": "currentPageReportTemplate", + "optional": true, + "readonly": false, + "type": "string", + "default": "'({currentPage} of {totalPages})'", + "description": "Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" + }, + { + "name": "lazy", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if data is loaded and interacted with in lazy manner." + }, + { + "name": "loading", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Displays a loader to indicate data load is in progress." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-spinner", + "description": "The icon to show while indicating data load is in progress." + }, + { + "name": "sortField", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or a getter function of a row data used for sorting by default" + }, + { + "name": "sortOrder", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Order to sort the data by default." + }, + { + "name": "defaultSortOrder", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Default sort order of an unsorted column." + }, + { + "name": "multiSortMeta", + "optional": true, + "readonly": false, + "type": "DataTableSortMeta[]", + "default": "", + "description": "An array of SortMeta objects to sort the data." + }, + { + "name": "sortMode", + "optional": true, + "readonly": false, + "type": "\"multiple\" | \"single\"", + "default": "single", + "description": "Defines whether sorting works on single column or on multiple columns." + }, + { + "name": "removableSort", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, columns can have an un-sorted state." + }, + { + "name": "filters", + "optional": true, + "readonly": false, + "type": "DataTableFilterMeta", + "default": "", + "description": "Filters object with key-value pairs to define the filters." + }, + { + "name": "filterDisplay", + "optional": true, + "readonly": false, + "type": "\"menu\" | \"row\"", + "default": "", + "description": "Layout of the filter elements." + }, + { + "name": "globalFilterFields", + "optional": true, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Fields for global filter" + }, + { + "name": "filterLocale", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Locale to use in filtering. The default locale is the host environment's current locale." + }, + { + "name": "selection", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row in single mode or an array of values in multiple mode." + }, + { + "name": "selectionMode", + "optional": true, + "readonly": false, + "type": "\"multiple\" | \"single\"", + "default": "", + "description": "Specifies the selection mode." + }, + { + "name": "compareSelectionBy", + "optional": true, + "readonly": false, + "type": "\"equals\" | \"deepEquals\"", + "default": "deepEquals", + "description": "Algorithm to define if a row is selected." + }, + { + "name": "metaKeySelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines whether metaKey is requred or not for the selection. When true metaKey needs to be pressed to select or unselect an item and\nwhen set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically." + }, + { + "name": "contextMenu", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Enables context menu integration." + }, + { + "name": "contextMenuSelection", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row instance with the ContextMenu." + }, + { + "name": "selectAll", + "optional": true, + "readonly": false, + "type": "Nullable", + "default": "", + "description": "Whether all data is selected." + }, + { + "name": "rowHover", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, background of the rows change on hover." + }, + { + "name": "csvSeparator", + "optional": true, + "readonly": false, + "type": "string", + "default": ",", + "description": "Character to use as the csv separator." + }, + { + "name": "exportFilename", + "optional": true, + "readonly": false, + "type": "string", + "default": "download", + "description": "Name of the exported file." + }, + { + "name": "resizableColumns", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, columns can be resized using drag and drop." + }, + { + "name": "columnResizeMode", + "optional": true, + "readonly": false, + "type": "\"fit\" | \"expand\"", + "default": "fit", + "description": "Defines whether the overall table width." + }, + { + "name": "reorderableColumns", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, columns can be reordered using drag and drop." + }, + { + "name": "expandedRows", + "optional": true, + "readonly": false, + "type": "null | any[] | DataTableExpandedRows", + "default": "", + "description": "A collection of row data display as expanded." + }, + { + "name": "expandedRowIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi-chevron-down", + "description": "Icon of the row toggler to display the row as expanded." + }, + { + "name": "collapsedRowIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi-chevron-right", + "description": "Icon of the row toggler to display the row as collapsed." + }, + { + "name": "rowGroupMode", + "optional": true, + "readonly": false, + "type": "\"rowspan\" | \"subheader\"", + "default": "", + "description": "Defines the row group mode." + }, + { + "name": "groupRowsBy", + "optional": true, + "readonly": false, + "type": "string | string[] | Function", + "default": "", + "description": "One or more field names to use in row grouping." + }, + { + "name": "expandableRowGroups", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the row groups can be expandable." + }, + { + "name": "expandedRowGroups", + "optional": true, + "readonly": false, + "type": "any[] | DataTableExpandedRows", + "default": "", + "description": "An array of group field values whose groups would be rendered as expanded." + }, + { + "name": "stateStorage", + "optional": true, + "readonly": false, + "type": "\"local\" | \"session\"", + "default": "session", + "description": "Defines where a stateful table keeps its state." + }, + { + "name": "stateKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Unique identifier of a stateful table to use in state storage." + }, + { + "name": "editMode", + "optional": true, + "readonly": false, + "type": "\"cell\" | \"row\"", + "default": "", + "description": "Defines the incell editing mode." + }, + { + "name": "editingRows", + "optional": true, + "readonly": false, + "type": "any[] | DataTableEditingRows", + "default": "", + "description": "A collection of rows to represent the current editing data in row edit mode." + }, + { + "name": "rowClass", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "rowStyle", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "scrollable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, enables horizontal and/or vertical scrolling." + }, + { + "name": "scrollHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Height of the scroll viewport in fixed pixels or the 'flex' keyword for a dynamic size." + }, + { + "name": "virtualScrollerOptions", + "optional": true, + "readonly": false, + "type": "VirtualScrollerProps", + "default": "", + "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.\nNote: Currently only vertical orientation mode is supported." + }, + { + "name": "frozenValue", + "optional": true, + "readonly": false, + "type": "null | any[]", + "default": "", + "description": "Items of the frozen part in scrollable DataTable." + }, + { + "name": "breakpoint", + "optional": true, + "readonly": false, + "type": "string", + "default": "960px", + "description": "The breakpoint to define the maximum width boundary when using stack responsive layout." + }, + { + "name": "showGridlines", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to show grid lines between cells." + }, + { + "name": "stripedRows", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to displays rows with alternating colors." + }, + { + "name": "tableStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the table element." + }, + { + "name": "tableClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the table element." + }, + { + "name": "tableProps", + "optional": true, + "readonly": false, + "type": "TableHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the TableHTMLAttributes to table element inside the component." + }, + { + "name": "filterInputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable filter input element inside the component." + } + ], + "methods": [ + { + "name": "exportFunction", + "parameters": [ + { + "name": "options", + "optional": false, + "type": "DataTableExportFunctionOptions" + } + ], + "returnType": "any", + "description": "Custom function to export data." + } + ] + }, + "DataTableSlots": { + "description": "Defines valid slots in DataTable component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + }, + { + "name": "paginatorstart", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator start template." + }, + { + "name": "paginatorend", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator end template." + }, + { + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." + }, + { + "name": "groupheader", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }" + } + ], + "returnType": "VNode[]", + "description": "Custom group header template." + }, + { + "name": "groupfooter", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", + "description": "group footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom group footer template." + }, + { + "name": "loading", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom loading template." + }, + { + "name": "expansion", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", + "description": "expansion slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom expansion template." + } + ] + }, "DataTableEmits": { "description": "Defines valid emits in Datatable component.", "relatedProp": "", "props": [], "methods": [ - { - "name": "cell-edit-cancel", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableCellEditCancelEvent", - "description": "Custom cell edit cancel event." - } - ], - "returnType": "void", - "description": "Callback to invoke when cell edit is cancelled with escape key." - }, - { - "name": "cell-edit-complete", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableCellEditCompleteEvent", - "description": "Custom cell edit complete event." - } - ], - "returnType": "void", - "description": "Callback to invoke when cell edit is completed." - }, - { - "name": "cell-edit-init", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableCellEditInitEvent", - "description": "Custom cell edit init." - } - ], - "returnType": "void", - "description": "Callback to invoke when cell edit is initiated." - }, - { - "name": "column-reorder", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableColumnReorderEvent", - "description": "Custom column reorder event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a column is reordered." - }, - { - "name": "column-resize-end", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableColumnResizeEndEvent" - } - ], - "returnType": "void", - "description": "Callback to invoke when a column is resized." - }, - { - "name": "filter", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableFilterEvent", - "description": "Custom filter event." - } - ], - "returnType": "void", - "description": "Event to emit after filtering, not triggered in lazy mode." - }, - { - "name": "page", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTablePageEvent", - "description": "Custom page event." - } - ], - "returnType": "void", - "description": "Callback to invoke on pagination. Sort and Filter information is also available for lazy loading implementation." - }, - { - "name": "row-click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowClickEvent", - "description": "Custom row click event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is clicked." - }, - { - "name": "row-collapse", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowCollapseEvent", - "description": "Custom row collapse event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is collapsed." - }, - { - "name": "row-contextmenu", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowContextMenuEvent", - "description": "Custom row context menu event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is selected with a ContextMenu." - }, - { - "name": "row-dblclick", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowDoubleClickEvent", - "description": "Custom row double click event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is double clicked." - }, - { - "name": "row-edit-cancel", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowEditCancelEvent", - "description": "Custom row edit cancel event." - } - ], - "returnType": "void", - "description": "Callback to invoke when row edit is cancelled." - }, - { - "name": "row-edit-init", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowEditInitEvent", - "description": "Custom row edit init event." - } - ], - "returnType": "void", - "description": "Callback to invoke when row edit is initiated." - }, - { - "name": "row-edit-save", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowEditSaveEvent", - "description": "Custom row edit save event." - } - ], - "returnType": "void", - "description": "Callback to invoke when row edit is saved." - }, - { - "name": "row-expand", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowExpandEvent", - "description": "Custom row expand event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is expanded." - }, - { - "name": "row-reorder", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowReorderEvent", - "description": "Custom row reorder event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is reordered." - }, - { - "name": "row-select", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowSelectEvent", - "description": "Custom row select event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is selected." - }, - { - "name": "row-select-all", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowSelectAllEvent", - "description": "Custom row select all event." - } - ], - "returnType": "void", - "description": "Fired when header checkbox is checked." - }, - { - "name": "row-unselect", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowUnselectEvent", - "description": "Custom row unselect event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row is unselected." - }, - { - "name": "row-unselect-all", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowUnselectAllEvent", - "description": "Custom row unselect all event." - } - ], - "returnType": "void", - "description": "Fired when header checkbox is unchecked." - }, - { - "name": "rowgroup-collapse", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowCollapseEvent", - "description": "Custom row collapse event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row group is collapsed." - }, - { - "name": "rowgroup-expand", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableRowExpandEvent", - "description": "Custom row expand event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a row group is expanded." - }, - { - "name": "select-all-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableSelectAllChangeEvent", - "description": "Custom select all change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when all data is selected." - }, - { - "name": "sort", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableSortEvent", - "description": "Custom sort event." - } - ], - "returnType": "void", - "description": "Callback to invoke on sort. Page and Filter information is also available for lazy loading implementation." - }, - { - "name": "state-restore", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableStateEvent", - "description": "Custom state event." - } - ], - "returnType": "void", - "description": "Invoked when a stateful table saves the state." - }, - { - "name": "state-save", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DataTableStateEvent", - "description": "Custom state event." - } - ], - "returnType": "void", - "description": "Invoked when a stateful table restores the state." - }, - { - "name": "update:contextMenuSelection", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the contextMenuSelection changes." - }, - { - "name": "update:editingRows", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any[] | DataTableEditingRows", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the editingRows changes." - }, - { - "name": "update:expandedRowGroups", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any[] | DataTableExpandedRows", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the expandedRowGroups changes." - }, - { - "name": "update:expandedRows", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any[] | DataTableExpandedRows", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the expandedRows changes." - }, - { - "name": "update:filters", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "DataTableFilterMeta", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the filters changes." - }, { "name": "update:first", "parameters": [ @@ -8482,19 +9627,6 @@ "returnType": "void", "description": "Emitted when the first changes." }, - { - "name": "update:multiSortMeta", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "undefined | null | DataTableSortMeta[]", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the multiSortMeta changes." - }, { "name": "update:rows", "parameters": [ @@ -8508,19 +9640,6 @@ "returnType": "void", "description": "Emitted when the rows changes." }, - { - "name": "update:selection", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the selection changes." - }, { "name": "update:sortField", "parameters": [ @@ -8547,6 +9666,136 @@ "returnType": "void", "description": "Emitted when the sortOrder changes." }, + { + "name": "update:multiSortMeta", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "undefined | null | DataTableSortMeta[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the multiSortMeta changes." + }, + { + "name": "update:selection", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the selection changes." + }, + { + "name": "update:contextMenuSelection", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the contextMenuSelection changes." + }, + { + "name": "update:expandedRows", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any[] | DataTableExpandedRows", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the expandedRows changes." + }, + { + "name": "update:expandedRowGroups", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any[] | DataTableExpandedRows", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the expandedRowGroups changes." + }, + { + "name": "update:filters", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "DataTableFilterMeta", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the filters changes." + }, + { + "name": "update:editingRows", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any[] | DataTableEditingRows", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the editingRows changes." + }, + { + "name": "page", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTablePageEvent", + "description": "Custom page event." + } + ], + "returnType": "void", + "description": "Callback to invoke on pagination. Sort and Filter information is also available for lazy loading implementation." + }, + { + "name": "sort", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableSortEvent", + "description": "Custom sort event." + } + ], + "returnType": "void", + "description": "Callback to invoke on sort. Page and Filter information is also available for lazy loading implementation." + }, + { + "name": "filter", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableFilterEvent", + "description": "Custom filter event." + } + ], + "returnType": "void", + "description": "Event to emit after filtering, not triggered in lazy mode." + }, { "name": "value-change", "parameters": [ @@ -8559,1555 +9808,306 @@ ], "returnType": "void", "description": "Callback to invoke after filtering, sorting, pagination and cell editing to pass the rendered value." + }, + { + "name": "row-click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowClickEvent", + "description": "Custom row click event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is clicked." + }, + { + "name": "row-dblclick", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowDoubleClickEvent", + "description": "Custom row double click event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is double clicked." + }, + { + "name": "row-contextmenu", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowContextMenuEvent", + "description": "Custom row context menu event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is selected with a ContextMenu." + }, + { + "name": "row-select", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowSelectEvent", + "description": "Custom row select event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is selected." + }, + { + "name": "row-select-all", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowSelectAllEvent", + "description": "Custom row select all event." + } + ], + "returnType": "void", + "description": "Fired when header checkbox is checked." + }, + { + "name": "row-unselect-all", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowUnselectAllEvent", + "description": "Custom row unselect all event." + } + ], + "returnType": "void", + "description": "Fired when header checkbox is unchecked." + }, + { + "name": "row-unselect", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowUnselectEvent", + "description": "Custom row unselect event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is unselected." + }, + { + "name": "select-all-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableSelectAllChangeEvent", + "description": "Custom select all change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when all data is selected." + }, + { + "name": "column-resize-end", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableColumnResizeEndEvent" + } + ], + "returnType": "void", + "description": "Callback to invoke when a column is resized." + }, + { + "name": "column-reorder", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableColumnReorderEvent", + "description": "Custom column reorder event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a column is reordered." + }, + { + "name": "row-reorder", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowReorderEvent", + "description": "Custom row reorder event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is reordered." + }, + { + "name": "row-expand", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowExpandEvent", + "description": "Custom row expand event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is expanded." + }, + { + "name": "row-collapse", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowCollapseEvent", + "description": "Custom row collapse event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row is collapsed." + }, + { + "name": "rowgroup-expand", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowExpandEvent", + "description": "Custom row expand event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row group is expanded." + }, + { + "name": "rowgroup-collapse", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowCollapseEvent", + "description": "Custom row collapse event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a row group is collapsed." + }, + { + "name": "cell-edit-init", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableCellEditInitEvent", + "description": "Custom cell edit init." + } + ], + "returnType": "void", + "description": "Callback to invoke when cell edit is initiated." + }, + { + "name": "cell-edit-complete", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableCellEditCompleteEvent", + "description": "Custom cell edit complete event." + } + ], + "returnType": "void", + "description": "Callback to invoke when cell edit is completed." + }, + { + "name": "cell-edit-cancel", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableCellEditCancelEvent", + "description": "Custom cell edit cancel event." + } + ], + "returnType": "void", + "description": "Callback to invoke when cell edit is cancelled with escape key." + }, + { + "name": "row-edit-init", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowEditInitEvent", + "description": "Custom row edit init event." + } + ], + "returnType": "void", + "description": "Callback to invoke when row edit is initiated." + }, + { + "name": "row-edit-save", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowEditSaveEvent", + "description": "Custom row edit save event." + } + ], + "returnType": "void", + "description": "Callback to invoke when row edit is saved." + }, + { + "name": "row-edit-cancel", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableRowEditCancelEvent", + "description": "Custom row edit cancel event." + } + ], + "returnType": "void", + "description": "Callback to invoke when row edit is cancelled." + }, + { + "name": "state-restore", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableStateEvent", + "description": "Custom state event." + } + ], + "returnType": "void", + "description": "Invoked when a stateful table saves the state." + }, + { + "name": "state-save", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataTableStateEvent", + "description": "Custom state event." + } + ], + "returnType": "void", + "description": "Invoked when a stateful table restores the state." } ] - }, - "DataTableExpandedRows": { - "description": "Custom datatable expanded rows.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "boolean" - } - ], - "methods": [] - }, - "DataTableExportCSVOptions": { - "description": "Custom datatable export csv metadata.", - "relatedProp": "", - "props": [ - { - "name": "selectionOnly", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether to export only selection data." - } - ], - "methods": [] - }, - "DataTableExportFunctionOptions": { - "description": "Custom datatable export metadata.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Row data" - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Column Field" - } - ], - "methods": [] - }, - "DataTableFilterEvent": { - "description": "Custom filter event.", - "relatedProp": "DataTableEmits.filter", - "props": [ - { - "name": "filterMatchModes", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Match modes per field" - }, - { - "name": "filteredValue", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Filtered collection (non-lazy only)" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "DataTableFilterMeta", - "default": "", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | DataTableSortMeta[]", - "default": "", - "description": "MultiSort metadata" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "undefined | string | Function", - "default": "", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Sort order as integer" - } - ], - "methods": [], - "extendedTypes": "DataTableSortEvent" - }, - "DataTableFilterMeta": { - "description": "Custom datatable filter metadata.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "string | DataTableFilterMetaData | DataTableOperatorFilterMetaData" - } - ], - "methods": [] - }, - "DataTableFilterMetaData": { - "description": "Custom datatable filter metadata.", - "relatedProp": "", - "props": [ - { - "name": "matchMode", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Filter match mode" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Filter value" - } - ], - "methods": [] - }, - "DataTableOperatorFilterMetaData": { - "description": "Custom datatable operator filter metadata.", - "relatedProp": "", - "props": [ - { - "name": "constraints", - "optional": false, - "readonly": false, - "type": "DataTableFilterMetaData[]", - "default": "", - "description": "Array of filter meta datas." - }, - { - "name": "operator", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Filter operator" - } - ], - "methods": [] - }, - "DataTablePageEvent": { - "description": "Custom pagination event.", - "relatedProp": "DataTableEmits.page", - "props": [ - { - "name": "filterMatchModes", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Match modes per field" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "DataTableFilterMeta", - "default": "", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | DataTableSortMeta[]", - "default": "", - "description": "MultiSort metadata" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - }, - { - "name": "page", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "New page number" - }, - { - "name": "pageCount", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Total page count" - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "undefined | string | Function", - "default": "", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Sort order as integer" - } - ], - "methods": [], - "extendedTypes": "DataTableSortEvent" - }, - "DataTableProps": { - "description": "Defines valid properties in DataTable component.", - "relatedProp": "", - "props": [ - { - "name": "alwaysShowPaginator", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show it even there is only one page." - }, - { - "name": "breakpoint", - "optional": true, - "readonly": false, - "type": "string", - "default": "960px", - "description": "The breakpoint to define the maximum width boundary when using stack responsive layout." - }, - { - "name": "collapsedRowIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi-chevron-right", - "description": "Icon of the row toggler to display the row as collapsed." - }, - { - "name": "columnResizeMode", - "optional": true, - "readonly": false, - "type": "\"fit\" | \"expand\"", - "default": "fit", - "description": "Defines whether the overall table width." - }, - { - "name": "compareSelectionBy", - "optional": true, - "readonly": false, - "type": "\"equals\" | \"deepEquals\"", - "default": "deepEquals", - "description": "Algorithm to define if a row is selected." - }, - { - "name": "contextMenu", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Enables context menu integration." - }, - { - "name": "contextMenuSelection", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected row instance with the ContextMenu." - }, - { - "name": "csvSeparator", - "optional": true, - "readonly": false, - "type": "string", - "default": ",", - "description": "Character to use as the csv separator." - }, - { - "name": "currentPageReportTemplate", - "optional": true, - "readonly": false, - "type": "string", - "default": "'({currentPage} of {totalPages})'", - "description": "Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Name of the field that uniquely identifies the a record in the data." - }, - { - "name": "defaultSortOrder", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Default sort order of an unsorted column." - }, - { - "name": "editMode", - "optional": true, - "readonly": false, - "type": "\"cell\" | \"row\"", - "default": "", - "description": "Defines the incell editing mode." - }, - { - "name": "editingRows", - "optional": true, - "readonly": false, - "type": "any[] | DataTableEditingRows", - "default": "", - "description": "A collection of rows to represent the current editing data in row edit mode." - }, - { - "name": "expandableRowGroups", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the row groups can be expandable." - }, - { - "name": "expandedRowGroups", - "optional": true, - "readonly": false, - "type": "any[] | DataTableExpandedRows", - "default": "", - "description": "An array of group field values whose groups would be rendered as expanded." - }, - { - "name": "expandedRowIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi-chevron-down", - "description": "Icon of the row toggler to display the row as expanded." - }, - { - "name": "expandedRows", - "optional": true, - "readonly": false, - "type": "null | any[] | DataTableExpandedRows", - "default": "", - "description": "A collection of row data display as expanded." - }, - { - "name": "exportFilename", - "optional": true, - "readonly": false, - "type": "string", - "default": "download", - "description": "Name of the exported file." - }, - { - "name": "filterDisplay", - "optional": true, - "readonly": false, - "type": "\"menu\" | \"row\"", - "default": "", - "description": "Layout of the filter elements." - }, - { - "name": "filterInputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable filter input element inside the component." - }, - { - "name": "filterLocale", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Locale to use in filtering. The default locale is the host environment's current locale." - }, - { - "name": "filters", - "optional": true, - "readonly": false, - "type": "DataTableFilterMeta", - "default": "", - "description": "Filters object with key-value pairs to define the filters." - }, - { - "name": "first", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Index of the first row to be displayed." - }, - { - "name": "frozenValue", - "optional": true, - "readonly": false, - "type": "null | any[]", - "default": "", - "description": "Items of the frozen part in scrollable DataTable." - }, - { - "name": "globalFilterFields", - "optional": true, - "readonly": false, - "type": "string[]", - "default": "", - "description": "Fields for global filter" - }, - { - "name": "groupRowsBy", - "optional": true, - "readonly": false, - "type": "string | string[] | Function", - "default": "", - "description": "One or more field names to use in row grouping." - }, - { - "name": "lazy", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if data is loaded and interacted with in lazy manner." - }, - { - "name": "loading", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Displays a loader to indicate data load is in progress." - }, - { - "name": "loadingIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-spinner", - "description": "The icon to show while indicating data load is in progress." - }, - { - "name": "metaKeySelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines whether metaKey is requred or not for the selection. When true metaKey needs to be pressed to select or unselect an item and\nwhen set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically." - }, - { - "name": "multiSortMeta", - "optional": true, - "readonly": false, - "type": "DataTableSortMeta[]", - "default": "", - "description": "An array of SortMeta objects to sort the data." - }, - { - "name": "pageLinkSize", - "optional": true, - "readonly": false, - "type": "number", - "default": "5", - "description": "Number of page links to display." - }, - { - "name": "paginator", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified as true, enables the pagination." - }, - { - "name": "paginatorPosition", - "optional": true, - "readonly": false, - "type": "\"both\" | \"top\" | \"bottom\"", - "default": "bottom", - "description": "Position of the paginator, options are 'top','bottom' or 'both'." - }, - { - "name": "paginatorTemplate", - "optional": true, - "readonly": false, - "type": "any", - "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", - "description": "Template of the paginator. It can be customized using the template property using the predefined keys.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" - }, - { - "name": "removableSort", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, columns can have an un-sorted state." - }, - { - "name": "reorderableColumns", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, columns can be reordered using drag and drop." - }, - { - "name": "resizableColumns", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, columns can be resized using drag and drop." - }, - { - "name": "rowClass", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "rowGroupMode", - "optional": true, - "readonly": false, - "type": "\"rowspan\" | \"subheader\"", - "default": "", - "description": "Defines the row group mode." - }, - { - "name": "rowHover", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, background of the rows change on hover." - }, - { - "name": "rowStyle", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "rows", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Number of rows to display per page." - }, - { - "name": "rowsPerPageOptions", - "optional": true, - "readonly": false, - "type": "number[]", - "default": "", - "description": "Array of integer values to display inside rows per page dropdown." - }, - { - "name": "scrollHeight", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Height of the scroll viewport in fixed pixels or the 'flex' keyword for a dynamic size." - }, - { - "name": "scrollable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, enables horizontal and/or vertical scrolling." - }, - { - "name": "selectAll", - "optional": true, - "readonly": false, - "type": "Nullable", - "default": "", - "description": "Whether all data is selected." - }, - { - "name": "selection", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected row in single mode or an array of values in multiple mode." - }, - { - "name": "selectionMode", - "optional": true, - "readonly": false, - "type": "\"multiple\" | \"single\"", - "default": "", - "description": "Specifies the selection mode." - }, - { - "name": "showGridlines", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to show grid lines between cells." - }, - { - "name": "sortField", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or a getter function of a row data used for sorting by default" - }, - { - "name": "sortMode", - "optional": true, - "readonly": false, - "type": "\"multiple\" | \"single\"", - "default": "single", - "description": "Defines whether sorting works on single column or on multiple columns." - }, - { - "name": "sortOrder", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Order to sort the data by default." - }, - { - "name": "stateKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Unique identifier of a stateful table to use in state storage." - }, - { - "name": "stateStorage", - "optional": true, - "readonly": false, - "type": "\"local\" | \"session\"", - "default": "session", - "description": "Defines where a stateful table keeps its state." - }, - { - "name": "stripedRows", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to displays rows with alternating colors." - }, - { - "name": "tableClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the table element." - }, - { - "name": "tableProps", - "optional": true, - "readonly": false, - "type": "TableHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the TableHTMLAttributes to table element inside the component." - }, - { - "name": "tableStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the table element." - }, - { - "name": "totalRecords", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Number of total records, defaults to length of value when not defined." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "null | any[]", - "default": "", - "description": "An array of objects to display." - }, - { - "name": "virtualScrollerOptions", - "optional": true, - "readonly": false, - "type": "VirtualScrollerProps", - "default": "", - "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.\nNote: Currently only vertical orientation mode is supported." - } - ], - "methods": [ - { - "name": "exportFunction", - "parameters": [ - { - "name": "options", - "optional": false, - "type": "DataTableExportFunctionOptions" - } - ], - "returnType": "any", - "description": "Custom function to export data." - } - ] - }, - "DataTableRowClickEvent": { - "description": "Custom row click event.", - "relatedProp": "DataTableEmits['row-click']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Row index." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - } - ], - "methods": [], - "extendedBy": "DataTableRowDoubleClickEvent,DataTableRowContextMenuEvent" - }, - "DataTableRowCollapseEvent": { - "description": "Custom row collapse event.", - "relatedProp": "DataTableEmits['row-expand']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Expanded row data" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedTypes": "DataTableRowExpandEvent" - }, - "DataTableRowContextMenuEvent": { - "description": "Custom row context menu event.", - "relatedProp": "DataTableEmits['row-contextmenu']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Row index." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - } - ], - "methods": [], - "extendedTypes": "DataTableRowClickEvent" - }, - "DataTableRowDoubleClickEvent": { - "description": "Custom row double click event.", - "relatedProp": "DataTableEmits['row-dblclick']]", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Row index." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - } - ], - "methods": [], - "extendedTypes": "DataTableRowClickEvent" - }, - "DataTableRowEditCancelEvent": { - "description": "Custom row edit cancel event.", - "relatedProp": "DataTableEmits['row-edit-cancel']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Row data to edit." - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the row data to edit." - }, - { - "name": "newData", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "New row data after editing." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedTypes": "DataTableRowEditInitEvent" - }, - "DataTableRowEditInitEvent": { - "description": "Custom row edit init event.", - "relatedProp": "DataTableEmits['row-edit-init']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Row data to edit." - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the row data to edit." - }, - { - "name": "newData", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "New row data after editing." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedBy": "DataTableRowEditSaveEvent,DataTableRowEditCancelEvent" - }, - "DataTableRowEditSaveEvent": { - "description": "Custom row edit save event.", - "relatedProp": "DataTableEmits['row-edit-save']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Row data to edit." - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the row data to edit." - }, - { - "name": "newData", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "New row data after editing." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedTypes": "DataTableRowEditInitEvent" - }, - "DataTableRowExpandEvent": { - "description": "Custom row expand event.", - "relatedProp": "DataTableEmits['row-expand']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Expanded row data" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedBy": "DataTableRowCollapseEvent" - }, - "DataTableRowReorderEvent": { - "description": "Custom row reorder event.", - "relatedProp": "DataTableEmits['row-reorder']", - "props": [ - { - "name": "dragIndex", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the dragged row" - }, - { - "name": "dropIndex", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the dropped row" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Reordered value" - } - ], - "methods": [] - }, - "DataTableRowSelectAllEvent": { - "description": "Custom row select all event.", - "relatedProp": "DataTableEmits['row-select-all']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected dataset" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [] - }, - "DataTableRowSelectEvent": { - "description": "Custom row select event.", - "relatedProp": "DataTableEmits['row-select']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected row data" - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Row index" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "type", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Type of the selection, valid values are 'row', 'radio' or 'checkbox'." - } - ], - "methods": [], - "extendedBy": "DataTableRowUnselectEvent" - }, - "DataTableRowUnselectAllEvent": { - "description": "Custom row unselect all event.", - "relatedProp": "DataTableEmits['row-unselect-all']", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [] - }, - "DataTableRowUnselectEvent": { - "description": "Custom row unselect event.", - "relatedProp": "DataTableEmits['row-unselect']", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected row data" - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Row index" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "type", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Type of the selection, valid values are 'row', 'radio' or 'checkbox'." - } - ], - "methods": [], - "extendedTypes": "DataTableRowSelectEvent" - }, - "DataTableSelectAllChangeEvent": { - "description": "Custom row select all change event.", - "relatedProp": "DataTableEmits['select-all-change']", - "props": [ - { - "name": "checked", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether all data is selected." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [] - }, - "DataTableSlots": { - "description": "Defines valid slots in DataTable component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template." - }, - { - "name": "expansion", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", - "description": "expansion slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom expansion template." - }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "groupfooter", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", - "description": "group footer slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom group footer template." - }, - { - "name": "groupheader", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }" - } - ], - "returnType": "VNode[]", - "description": "Custom group header template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "loading", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom loading template." - }, - { - "name": "paginatorend", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom paginator end template." - }, - { - "name": "paginatorstart", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom paginator start template." - } - ] - }, - "DataTableSortEvent": { - "description": "Custom sort event.", - "relatedProp": "DataTableEmits.sort", - "props": [ - { - "name": "filterMatchModes", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Match modes per field" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "DataTableFilterMeta", - "default": "", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | DataTableSortMeta[]", - "default": "", - "description": "MultiSort metadata" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "undefined | string | Function", - "default": "", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Sort order as integer" - } - ], - "methods": [], - "extendedBy": "DataTablePageEvent,DataTableFilterEvent" - }, - "DataTableSortMeta": { - "description": "Custom datatable sort meta.", - "relatedProp": "", - "props": [ - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Column field" - }, - { - "name": "order", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Column sort order" - } - ], - "methods": [] - }, - "DataTableStateEvent": { - "description": "Custom state event.", - "relatedProp": "DataTableEmits['state-save']", - "props": [ - { - "name": "columWidths", - "optional": false, - "readonly": false, - "type": "string[]", - "default": "", - "description": "Comma separated list of column widths" - }, - { - "name": "columnOrder", - "optional": false, - "readonly": false, - "type": "string[]", - "default": "", - "description": "Order of the columns" - }, - { - "name": "expandedRowGroups", - "optional": false, - "readonly": false, - "type": "any[] | DataTableExpandedRows", - "default": "", - "description": "Instances of rows in expanded state" - }, - { - "name": "expandedRowKeys", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Keys of rows in expanded state" - }, - { - "name": "expandedRows", - "optional": false, - "readonly": false, - "type": "any[] | DataTableExpandedRows", - "default": "", - "description": "Instances of rows in expanded state" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "DataTableFilterMeta", - "default": "", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | DataTableSortMeta[]", - "default": "", - "description": "MultiSort metadata" - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - }, - { - "name": "selection", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Selected rows" - }, - { - "name": "selectionKeys", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Keys of selected rows" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Sort order as integer" - } - ], - "methods": [] } } } @@ -10129,24 +10129,248 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "DataViewEmits": { + "DataViewPageEvent": { + "description": "Custom page event.", + "relatedProp": "DataViewEmits.page", + "props": [ + { + "name": "page", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "New page number" + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "pageCount", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Total number of pages" + } + ], + "methods": [] + }, + "DataViewProps": { + "description": "Defines valid properties in DataView component. In addition to these, all properties of HTMLDivElement can be used in this component.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "An array of objects to display." + }, + { + "name": "layout", + "optional": true, + "readonly": false, + "type": "\"grid\" | \"list\"", + "default": "list", + "description": "Layout of the items, valid values are 'list' and 'grid'." + }, + { + "name": "rows", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Number of rows to display per page." + }, + { + "name": "first", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Index of the first record to render." + }, + { + "name": "totalRecords", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of total records, defaults to length of value when not defined." + }, + { + "name": "paginator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified as true, enables the pagination." + }, + { + "name": "paginatorPosition", + "optional": true, + "readonly": false, + "type": "\"both\" | \"top\" | \"bottom\"", + "default": "bottom", + "description": "Position of the paginator, options are 'top','bottom' or 'both'." + }, + { + "name": "alwaysShowPaginator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show it even there is only one page." + }, + { + "name": "paginatorTemplate", + "optional": true, + "readonly": false, + "type": "string", + "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", + "description": "Template of the paginator. It can be customized using the template property using the predefined keys,\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" + }, + { + "name": "pageLinkSize", + "optional": true, + "readonly": false, + "type": "number", + "default": "5", + "description": "Number of page links to display." + }, + { + "name": "rowsPerPageOptions", + "optional": true, + "readonly": false, + "type": "number[]", + "default": "", + "description": "Array of integer values to display inside rows per page dropdown." + }, + { + "name": "currentPageReportTemplate", + "optional": true, + "readonly": false, + "type": "string", + "default": "'({currentPage} of {totalPages})'", + "description": "Template of the current page report element. It displays information about the pagination state.\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" + }, + { + "name": "sortField", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or a getter function of data to use in sorting by default." + }, + { + "name": "sortOrder", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Order to sort the data by default." + }, + { + "name": "lazy", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if data is loaded and interacted with in lazy manner." + }, + { + "name": "dataKey", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Name of the data that uniquely identifies the a record in the data." + } + ], + "methods": [] + }, + "DataViewSlots": { "description": "Defines valid slots in DataView component.", "relatedProp": "", "props": [], "methods": [ { - "name": "page", + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + }, + { + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." + }, + { + "name": "paginatorstart", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator start template." + }, + { + "name": "paginatorend", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator end template." + }, + { + "name": "list", "parameters": [ { - "name": "event", + "name": "scope", "optional": false, - "type": "DataViewPageEvent", - "description": "Custom page event." + "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }", + "description": "list slot's params." } ], - "returnType": "void", - "description": "Callback to invoke when page changes, the event object contains information about the new state." + "returnType": "VNode[]", + "description": "Custom list template." }, + { + "name": "grid", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }", + "description": "list slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom list template." + } + ] + }, + "DataViewEmits": { + "description": "Defines valid slots in DataView component.", + "relatedProp": "", + "props": [], + "methods": [ { "name": "update:first", "parameters": [ @@ -10172,243 +10396,19 @@ ], "returnType": "void", "description": "Emitted when the rows changes." - } - ] - }, - "DataViewPageEvent": { - "description": "Custom page event.", - "relatedProp": "DataViewEmits.page", - "props": [ - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" }, { "name": "page", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "New page number" - }, - { - "name": "pageCount", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Total number of pages" - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - } - ], - "methods": [] - }, - "DataViewProps": { - "description": "Defines valid properties in DataView component. In addition to these, all properties of HTMLDivElement can be used in this component.", - "relatedProp": "", - "props": [ - { - "name": "alwaysShowPaginator", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show it even there is only one page." - }, - { - "name": "currentPageReportTemplate", - "optional": true, - "readonly": false, - "type": "string", - "default": "'({currentPage} of {totalPages})'", - "description": "Template of the current page report element. It displays information about the pagination state.\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" - }, - { - "name": "dataKey", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Name of the data that uniquely identifies the a record in the data." - }, - { - "name": "first", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Index of the first record to render." - }, - { - "name": "layout", - "optional": true, - "readonly": false, - "type": "\"grid\" | \"list\"", - "default": "list", - "description": "Layout of the items, valid values are 'list' and 'grid'." - }, - { - "name": "lazy", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if data is loaded and interacted with in lazy manner." - }, - { - "name": "pageLinkSize", - "optional": true, - "readonly": false, - "type": "number", - "default": "5", - "description": "Number of page links to display." - }, - { - "name": "paginator", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified as true, enables the pagination." - }, - { - "name": "paginatorPosition", - "optional": true, - "readonly": false, - "type": "\"both\" | \"top\" | \"bottom\"", - "default": "bottom", - "description": "Position of the paginator, options are 'top','bottom' or 'both'." - }, - { - "name": "paginatorTemplate", - "optional": true, - "readonly": false, - "type": "string", - "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", - "description": "Template of the paginator. It can be customized using the template property using the predefined keys,\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" - }, - { - "name": "rows", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Number of rows to display per page." - }, - { - "name": "rowsPerPageOptions", - "optional": true, - "readonly": false, - "type": "number[]", - "default": "", - "description": "Array of integer values to display inside rows per page dropdown." - }, - { - "name": "sortField", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or a getter function of data to use in sorting by default." - }, - { - "name": "sortOrder", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Order to sort the data by default." - }, - { - "name": "totalRecords", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of total records, defaults to length of value when not defined." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "any[]", - "default": "", - "description": "An array of objects to display." - } - ], - "methods": [] - }, - "DataViewSlots": { - "description": "Defines valid slots in DataView component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template." - }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "grid", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }", - "description": "list slot's params." + "type": "DataViewPageEvent", + "description": "Custom page event." } ], - "returnType": "VNode[]", - "description": "Custom list template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "list", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }", - "description": "list slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom list template." - }, - { - "name": "paginatorend", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom paginator end template." - }, - { - "name": "paginatorstart", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom paginator start template." + "returnType": "void", + "description": "Callback to invoke when page changes, the event object contains information about the new state." } ] } @@ -10432,26 +10432,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "DataViewLayoutOptionsEmits": { - "description": "Defines valid emits in DataViewLayoutOptions component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "string", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "DataViewLayoutOptionsProps": { "description": "Defines valid properties in DataViewLayoutOptions component.", "relatedProp": "", @@ -10472,6 +10452,26 @@ "relatedProp": "", "props": [], "methods": [] + }, + "DataViewLayoutOptionsEmits": { + "description": "Defines valid emits in DataViewLayoutOptions component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] } } } @@ -10493,32 +10493,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "DeferredContentEmits": { - "description": "Defines valid emits in DeferredContent component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "load", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when deferred content is loaded." - } - ] - }, - "DeferredContentPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "DeferredContentPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -10555,6 +10529,34 @@ ], "methods": [] }, + "DeferredContentPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "DeferredContentState": { + "description": "Defines current inline state in DeferredContent component.", + "relatedProp": "", + "props": [ + { + "name": "loaded", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current loaded state as a boolean." + } + ], + "methods": [] + }, "DeferredContentProps": { "description": "Defines valid props in DeferredContent component.", "relatedProp": "", @@ -10583,20 +10585,18 @@ } ] }, - "DeferredContentState": { - "description": "Defines current inline state in DeferredContent component.", + "DeferredContentEmits": { + "description": "Defines valid emits in DeferredContent component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { - "name": "loaded", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current loaded state as a boolean." + "name": "load", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when deferred content is loaded." } - ], - "methods": [] + ] } } }, @@ -10639,142 +10639,49 @@ ], "methods": [] }, - "DialogEmits": { - "description": "Defines valid emits in Dialog component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "after-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke after dialog is hidden." - }, - { - "name": "dragend", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Fired when a dialog drag completes." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when dialog is hidden." - }, - { - "name": "maximize", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Fired when a dialog gets maximized." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when dialog is shown." - }, - { - "name": "unmaximize", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Fired when a dialog gets unmaximized." - }, - { - "name": "update:visible", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the visible changes." - } - ] - }, "DialogProps": { "description": "Defines valid properties in Dialog component.", "relatedProp": "", "props": [ { - "name": "appendTo", - "optional": true, - "readonly": false, - "type": "string | HTMLElement", - "default": "body", - "description": "A valid query selector or an HTMLElement to specify where the dialog gets attached." - }, - { - "name": "autoZIndex", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to automatically manage layering." - }, - { - "name": "baseZIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Base zIndex value to use in layering." - }, - { - "name": "breakpoints", - "optional": true, - "readonly": false, - "type": "DialogBreakpoints", - "default": "", - "description": "Object literal to define widths per screen size." - }, - { - "name": "closable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Adds a close icon to the header to hide the dialog." - }, - { - "name": "closeIcon", + "name": "header", "optional": true, "readonly": false, "type": "string", - "default": "pi pi-times", - "description": "Icon to display in the dialog close button." + "default": "", + "description": "Title content of the dialog." }, { - "name": "closeOnEscape", + "name": "footer", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Footer content of the dialog." + }, + { + "name": "visible", "optional": true, "readonly": false, "type": "boolean", - "default": "true", - "description": "Specifies if pressing escape key should hide the dialog." + "default": "false", + "description": "Specifies the visibility of the dialog." + }, + { + "name": "modal", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if background should be blocked when dialog is displayed." + }, + { + "name": "contentStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style of the content section." }, { "name": "contentClass", @@ -10793,12 +10700,20 @@ "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." }, { - "name": "contentStyle", + "name": "rtl", "optional": true, "readonly": false, - "type": "any", - "default": "", - "description": "Style of the content section." + "type": "boolean", + "default": "false", + "description": "When enabled dialog is displayed in RTL direction." + }, + { + "name": "closable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Adds a close icon to the header to hide the dialog." }, { "name": "dismissableMask", @@ -10809,36 +10724,44 @@ "description": "Specifies if clicking the modal background should hide the dialog." }, { - "name": "draggable", + "name": "closeOnEscape", "optional": true, "readonly": false, "type": "boolean", "default": "true", - "description": "Enables dragging to change the position using header." + "description": "Specifies if pressing escape key should hide the dialog." }, { - "name": "footer", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Footer content of the dialog." - }, - { - "name": "header", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Title content of the dialog." - }, - { - "name": "keepInViewPort", + "name": "showHeader", "optional": true, "readonly": false, "type": "boolean", "default": "true", - "description": "Keeps dialog in the viewport when dragging." + "description": "Whether to show the header or not." + }, + { + "name": "baseZIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Base zIndex value to use in layering." + }, + { + "name": "autoZIndex", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to automatically manage layering." + }, + { + "name": "position", + "optional": true, + "readonly": false, + "type": "\"center\" | \"left\" | \"top\" | \"bottom\" | \"right\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\"", + "default": "center", + "description": "Position of the dialog." }, { "name": "maximizable", @@ -10849,12 +10772,28 @@ "description": "Whether the dialog can be displayed full screen." }, { - "name": "maximizeIcon", + "name": "breakpoints", "optional": true, "readonly": false, - "type": "string", - "default": "pi pi-window-maximize", - "description": "Icon to display in the dialog maximize button when dialog is not maximized." + "type": "DialogBreakpoints", + "default": "", + "description": "Object literal to define widths per screen size." + }, + { + "name": "draggable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Enables dragging to change the position using header." + }, + { + "name": "keepInViewPort", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Keeps dialog in the viewport when dragging." }, { "name": "minX", @@ -10873,44 +10812,12 @@ "description": "Minimum value for the top coordinate of dialog in dragging." }, { - "name": "minimizeIcon", + "name": "appendTo", "optional": true, "readonly": false, - "type": "string", - "default": "pi pi-window-minimize", - "description": "Icon to display in the dialog maximize button when dialog is maximized." - }, - { - "name": "modal", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if background should be blocked when dialog is displayed." - }, - { - "name": "position", - "optional": true, - "readonly": false, - "type": "\"center\" | \"left\" | \"top\" | \"bottom\" | \"right\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\"", - "default": "center", - "description": "Position of the dialog." - }, - { - "name": "rtl", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled dialog is displayed in RTL direction." - }, - { - "name": "showHeader", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show the header or not." + "type": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the dialog gets attached." }, { "name": "style", @@ -10921,12 +10828,28 @@ "description": "Style of the dynamic dialog." }, { - "name": "visible", + "name": "closeIcon", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Specifies the visibility of the dialog." + "type": "string", + "default": "pi pi-times", + "description": "Icon to display in the dialog close button." + }, + { + "name": "maximizeIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-window-maximize", + "description": "Icon to display in the dialog maximize button when dialog is not maximized." + }, + { + "name": "minimizeIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-window-minimize", + "description": "Icon to display in the dialog maximize button when dialog is maximized." } ], "methods": [] @@ -10942,17 +10865,94 @@ "returnType": "VNode[]", "description": "Default content slot." }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, { "name": "header", "parameters": [], "returnType": "VNode[]", "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + } + ] + }, + "DialogEmits": { + "description": "Defines valid emits in Dialog component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:visible", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the visible changes." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when dialog is hidden." + }, + { + "name": "after-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke after dialog is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when dialog is shown." + }, + { + "name": "maximize", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Fired when a dialog gets maximized." + }, + { + "name": "unmaximize", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Fired when a dialog gets unmaximized." + }, + { + "name": "dragend", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Fired when a dialog drag completes." } ] } @@ -11012,24 +11012,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "DividerEmits": { - "relatedProp": "", - "props": [], - "methods": [] - }, - "DividerPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "DividerPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -11048,14 +11030,6 @@ "description": "Custom passthrough(pt) options.", "relatedProp": "DividerProps.pt", "props": [ - { - "name": "content", - "optional": true, - "readonly": false, - "type": "DividerPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the content's DOM element." - }, { "name": "root", "optional": true, @@ -11063,6 +11037,27 @@ "type": "DividerPassThroughOptionType", "default": "", "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "DividerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + } + ], + "methods": [] + }, + "DividerPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" } ], "methods": [] @@ -11087,14 +11082,6 @@ "default": "horizontal", "description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'." }, - { - "name": "pt", - "optional": true, - "readonly": false, - "type": "DividerPassThroughOptions", - "default": "", - "description": "Uses to pass attributes to DOM elements inside the component." - }, { "name": "type", "optional": true, @@ -11102,6 +11089,14 @@ "type": "\"dashed\" | \"dotted\" | \"solid\"", "default": "solid", "description": "Border style type." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "DividerPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -11118,6 +11113,11 @@ "description": "Default content slot." } ] + }, + "DividerEmits": { + "relatedProp": "", + "props": [], + "methods": [] } } }, @@ -11147,159 +11147,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "DockEmits": { - "description": "Defines valid emits in Dock component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - } - ] - }, - "DockProps": { - "description": "Defines valid properties in Dock component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "class", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the element." - }, - { - "name": "exact", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." - }, - { - "name": "menuId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Unique identifier of the menu." - }, - { - "name": "model", - "optional": true, - "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "MenuModel instance to define the action items." - }, - { - "name": "position", - "optional": true, - "readonly": false, - "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "bottom", - "description": "Position of element." - }, - { - "name": "style", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the element." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "string | number", - "default": "", - "description": "Index of the element in tabbing order." - }, - { - "name": "tooltipOptions", - "optional": true, - "readonly": false, - "type": "DockTooltipOptions", - "default": "", - "description": "Whether to display the tooltip on items. The modifiers of Tooltip can be used like an object in it. Valid keys are 'event' and 'position'." - } - ], - "methods": [] - }, - "DockSlots": { - "description": "Defines valid slots in Dock component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "icon", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t item: MenuItem, // Custom content for icon.\n }", - "description": "icon slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom icon content." - }, - { - "name": "item", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t index: number, // Index of the menuitem\n \t item: MenuItem, // Custom content for item.\n }", - "description": "item slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom item content." - } - ] - }, "DockTooltipOptions": { "description": "Defines tooltip options", "relatedProp": "", @@ -11328,6 +11175,159 @@ } ], "methods": [] + }, + "DockProps": { + "description": "Defines valid properties in Dock component.", + "relatedProp": "", + "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "MenuModel instance to define the action items." + }, + { + "name": "position", + "optional": true, + "readonly": false, + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "bottom", + "description": "Position of element." + }, + { + "name": "class", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the element." + }, + { + "name": "style", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the element." + }, + { + "name": "exact", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." + }, + { + "name": "tooltipOptions", + "optional": true, + "readonly": false, + "type": "DockTooltipOptions", + "default": "", + "description": "Whether to display the tooltip on items. The modifiers of Tooltip can be used like an object in it. Valid keys are 'event' and 'position'." + }, + { + "name": "menuId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Unique identifier of the menu." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string | number", + "default": "", + "description": "Index of the element in tabbing order." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." + } + ], + "methods": [] + }, + "DockSlots": { + "description": "Defines valid slots in Dock component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "item", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: MenuItem, // Custom content for item.\n \t index: number, // Index of the menuitem\n }", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item content." + }, + { + "name": "icon", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: MenuItem, // Custom content for icon.\n }", + "description": "icon slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom icon content." + } + ] + }, + "DockEmits": { + "description": "Defines valid emits in Dock component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + } + ] } } } @@ -11372,102 +11372,6 @@ ], "methods": [] }, - "DropdownEmits": { - "description": "Defines valid emits in Dropdown component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "before-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is hidden." - }, - { - "name": "before-show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is shown." - }, - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DropdownChangeEvent", - "description": "Custom change event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "filter", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "DropdownFilterEvent", - "description": "Custom filter event." - } - ], - "returnType": "void", - "description": "Callback to invoke on filter input." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is hidden." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is shown." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "DropdownFilterEvent": { "description": "Custom filter event.", "relatedProp": "DropdownEmits.filter", @@ -11495,230 +11399,6 @@ "description": "Defines valid properties in Dropdown component.", "relatedProp": "", "props": [ - { - "name": "appendTo", - "optional": true, - "readonly": false, - "type": "string | HTMLElement", - "default": "body", - "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "autoFilterFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to focus on the filter element when the overlay panel is shown." - }, - { - "name": "autoOptionFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." - }, - { - "name": "clearIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times", - "description": "Icon to display in clear button." - }, - { - "name": "clearIconProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLElement to the clear icon inside the component." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "A property to uniquely identify an option." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "dropdownIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-down", - "description": "Icon to display in the dropdown." - }, - { - "name": "editable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, custom value instead of predefined options can be entered using the editable input field." - }, - { - "name": "emptyFilterMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptyMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results foun", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptySelectionMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No selected item", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "filter", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, displays a filter input at header." - }, - { - "name": "filterFields", - "optional": true, - "readonly": false, - "type": "string[]", - "default": "", - "description": "Fields used when filtering the options, defaults to optionLabel." - }, - { - "name": "filterIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-search", - "description": "Icon to display in filter input." - }, - { - "name": "filterInputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the filter input inside the component." - }, - { - "name": "filterLocale", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Locale to use in filtering. The default locale is the host environment's current locale." - }, - { - "name": "filterMatchMode", - "optional": true, - "readonly": false, - "type": "string", - "default": "contains", - "description": "Defines the filtering algorithm to use when searching the options." - }, - { - "name": "filterMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "'{0} results are available'", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "filterPlaceholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text to show when filter input is empty." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes | InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "loading", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the dropdown is in loading state." - }, - { - "name": "loadingIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-spinner pi-spin", - "description": "Icon to display in loading state." - }, { "name": "modelValue", "optional": true, @@ -11728,28 +11408,12 @@ "description": "Value of the component." }, { - "name": "optionDisabled", + "name": "options", "optional": true, "readonly": false, - "type": "string | Function", + "type": "any[]", "default": "", - "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." - }, - { - "name": "optionGroupChildren", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function that refers to the children options of option group." - }, - { - "name": "optionGroupLabel", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the label of an option group." + "description": "An array of selectitems to display as the available options." }, { "name": "optionLabel", @@ -11768,12 +11432,156 @@ "description": "Property name or getter function to use as the value of an option, defaults to the option itself when not defined." }, { - "name": "options", + "name": "optionDisabled", "optional": true, "readonly": false, - "type": "any[]", + "type": "string | Function", "default": "", - "description": "An array of selectitems to display as the available options." + "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." + }, + { + "name": "optionGroupLabel", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function to use as the label of an option group." + }, + { + "name": "optionGroupChildren", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function that refers to the children options of option group." + }, + { + "name": "scrollHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "200px", + "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." + }, + { + "name": "filter", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, displays a filter input at header." + }, + { + "name": "filterPlaceholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Placeholder text to show when filter input is empty." + }, + { + "name": "filterLocale", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Locale to use in filtering. The default locale is the host environment's current locale." + }, + { + "name": "filterMatchMode", + "optional": true, + "readonly": false, + "type": "string", + "default": "contains", + "description": "Defines the filtering algorithm to use when searching the options." + }, + { + "name": "filterFields", + "optional": true, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Fields used when filtering the options, defaults to optionLabel." + }, + { + "name": "editable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, custom value instead of predefined options can be entered using the editable input field." + }, + { + "name": "placeholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Default text to display when no option is selected." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "A property to uniquely identify an option." + }, + { + "name": "showClear", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, a clear icon is displayed to clear the value." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes | InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component." + }, + { + "name": "panelStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the overlay panel." }, { "name": "panelClass", @@ -11792,20 +11600,68 @@ "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." }, { - "name": "panelStyle", + "name": "filterInputProps", "optional": true, "readonly": false, - "type": "object", + "type": "InputHTMLAttributes", "default": "", - "description": "Inline style of the overlay panel." + "description": "Uses to pass all properties of the HTMLInputElement to the filter input inside the component." }, { - "name": "placeholder", + "name": "clearIconProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLElement to the clear icon inside the component." + }, + { + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." + }, + { + "name": "loading", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the dropdown is in loading state." + }, + { + "name": "clearIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Default text to display when no option is selected." + "default": "pi pi-times", + "description": "Icon to display in clear button." + }, + { + "name": "dropdownIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." + }, + { + "name": "filterIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-search", + "description": "Icon to display in filter input." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." }, { "name": "resetFilterOnHide", @@ -11816,12 +11672,28 @@ "description": "Clears the filter value when hiding the dropdown." }, { - "name": "scrollHeight", + "name": "virtualScrollerOptions", "optional": true, "readonly": false, - "type": "string", - "default": "200px", - "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." + "type": "VirtualScrollerProps", + "default": "", + "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it." + }, + { + "name": "autoOptionFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." + }, + { + "name": "autoFilterFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to focus on the filter element when the overlay panel is shown." }, { "name": "selectOnFocus", @@ -11831,6 +11703,14 @@ "default": "false", "description": "When enabled, the focused option is selected." }, + { + "name": "filterMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "'{0} results are available'", + "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." + }, { "name": "selectionMessage", "optional": true, @@ -11840,12 +11720,28 @@ "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { - "name": "showClear", + "name": "emptySelectionMessage", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, a clear icon is displayed to clear the value." + "type": "string", + "default": "No selected item", + "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptyFilterMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found", + "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptyMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results foun", + "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." }, { "name": "tabindex", @@ -11856,12 +11752,20 @@ "description": "Index of the element in tabbing order." }, { - "name": "virtualScrollerOptions", + "name": "aria-label", "optional": true, "readonly": false, - "type": "VirtualScrollerProps", + "type": "string", "default": "", - "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it." + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." } ], "methods": [] @@ -11871,6 +11775,89 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "value", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t placeholder: string, // Placeholder prop value\n }", + "description": "value slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom value template." + }, + { + "name": "indicator", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." + }, + { + "name": "header", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t options: any, // Displayed options\n }", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template of panel." + }, + { + "name": "footer", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t options: any, // Displayed options\n }", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template of panel." + }, + { + "name": "option", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." + }, + { + "name": "optiongroup", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option group slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option group template." + }, + { + "name": "emptyfilter", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty filter template." + }, + { + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." + }, { "name": "content", "parameters": [ @@ -11884,50 +11871,6 @@ "returnType": "VNode[]", "description": "Custom content template." }, - { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template." - }, - { - "name": "emptyfilter", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty filter template." - }, - { - "name": "footer", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "footer slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom footer template of panel." - }, - { - "name": "header", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "header slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom header template of panel." - }, - { - "name": "indicator", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom indicator template." - }, { "name": "loader", "parameters": [ @@ -11940,45 +11883,102 @@ ], "returnType": "VNode[]", "description": "Custom loader template." - }, + } + ] + }, + "DropdownEmits": { + "description": "Defines valid emits in Dropdown component.", + "relatedProp": "", + "props": [], + "methods": [ { - "name": "option", + "name": "update:modelValue", "parameters": [ { - "name": "scope", + "name": "value", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "option slot's params." + "type": "any", + "description": "New value." } ], - "returnType": "VNode[]", - "description": "Custom option template." + "returnType": "void", + "description": "Emitted when the value changes." }, { - "name": "optiongroup", + "name": "change", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "option group slot's params." + "type": "DropdownChangeEvent", + "description": "Custom change event." } ], - "returnType": "VNode[]", - "description": "Custom option group template." + "returnType": "void", + "description": "Callback to invoke on value change." }, { - "name": "value", + "name": "focus", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }", - "description": "value slot's params." + "type": "Event", + "description": "Browser event." } ], - "returnType": "VNode[]", - "description": "Custom value template." + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "before-show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is shown." + }, + { + "name": "before-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is hidden." + }, + { + "name": "filter", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DropdownFilterEvent", + "description": "Custom filter event." + } + ], + "returnType": "void", + "description": "Callback to invoke on filter input." } ] } @@ -12002,14 +12002,14 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "DynamicDialogEmits": { - "description": "Defines valid emits in DynamicDialog component.", + "DynamicDialogProps": { + "description": "Defines valid properties in DynamicDialog component.", "relatedProp": "", "props": [], "methods": [] }, - "DynamicDialogProps": { - "description": "Defines valid properties in DynamicDialog component.", + "DynamicDialogEmits": { + "description": "Defines valid emits in DynamicDialog component.", "relatedProp": "", "props": [], "methods": [] @@ -12031,6 +12031,29 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "DynamicDialogTemplates": { + "description": "Custom dialog templates.", + "relatedProp": "", + "props": [ + { + "name": "header", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Custom header template." + }, + { + "name": "footer", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Custom footer template." + } + ], + "methods": [] + }, "DynamicDialogCloseOptions": { "description": "Dynamic Dialog close method options.", "relatedProp": "", @@ -12054,56 +12077,10 @@ ], "methods": [] }, - "DynamicDialogInstance": { - "description": "Custom Dynamic Dialog options.", - "relatedProp": "", - "props": [ - { - "name": "close", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "content", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Dynamic component for content template" - }, - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Custom data object" - }, - { - "name": "options", - "optional": false, - "readonly": false, - "type": "DynamicDialogOptions", - "default": "", - "description": "Instance options" - } - ], - "methods": [] - }, "DynamicDialogOptions": { "description": "Custom Dynamic Dialog options.", "relatedProp": "", "props": [ - { - "name": "data", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Custom data object" - }, { "name": "props", "optional": true, @@ -12120,6 +12097,14 @@ "default": "", "description": "Dialog Slots" }, + { + "name": "data", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Custom data object" + }, { "name": "[key: string]", "optional": false, @@ -12142,25 +12127,40 @@ } ] }, - "DynamicDialogTemplates": { - "description": "Custom dialog templates.", + "DynamicDialogInstance": { + "description": "Custom Dynamic Dialog options.", "relatedProp": "", "props": [ { - "name": "footer", - "optional": true, + "name": "content", + "optional": false, "readonly": false, "type": "any", "default": "", - "description": "Custom footer template." + "description": "Dynamic component for content template" }, { - "name": "header", - "optional": true, + "name": "options", + "optional": false, + "readonly": false, + "type": "DynamicDialogOptions", + "default": "", + "description": "Instance options" + }, + { + "name": "data", + "optional": false, "readonly": false, "type": "any", "default": "", - "description": "Custom header template." + "description": "Custom data object" + }, + { + "name": "close", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" } ], "methods": [] @@ -12185,64 +12185,107 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "EditorEmits": { - "description": "Defines valid emits in Editor component.", - "relatedProp": "", - "props": [], - "methods": [ + "EditorTextChangeEvent": { + "description": "Custom text change event.", + "relatedProp": "EditorEmits['text-change']", + "props": [ { - "name": "load", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "EditorLoadEvent", - "description": "Custom load event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the quill modules are loaded." + "name": "htmlValue", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current value as html." }, { - "name": "selection-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "EditorSelectionChangeEvent", - "description": "Custom selection change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when selection of the text changes." + "name": "textValue", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Current value as text." }, { - "name": "text-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "EditorTextChangeEvent", - "description": "Custom text change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when text of editor changes." + "name": "delta", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Representation of the change." }, { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "string", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." + "name": "source", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Source of change. Will be either 'user' or 'api'." + }, + { + "name": "instance", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Text editor instance." } - ] + ], + "methods": [] + }, + "EditorSelectionChangeEvent": { + "description": "Custom selection change event.", + "relatedProp": "EditorEmits['selection-change']", + "props": [ + { + "name": "htmlValue", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current value as html." + }, + { + "name": "textValue", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Current value as text." + }, + { + "name": "range", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Representation of the selection boundaries." + }, + { + "name": "oldRange", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Representation of the previous selection boundaries." + }, + { + "name": "source", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Source of change. Will be either 'user' or 'api'." + }, + { + "name": "instance", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Text editor instance." + } + ], + "methods": [] }, "EditorLoadEvent": { "description": "Custom load event.", @@ -12263,22 +12306,6 @@ "description": "Defines valid properties in Editor component.", "relatedProp": "", "props": [ - { - "name": "editorStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the container." - }, - { - "name": "formats", - "optional": true, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Whitelist of formats to display, see [here](https://quilljs.com/docs/formats/) for available options." - }, { "name": "modelValue", "optional": true, @@ -12287,14 +12314,6 @@ "default": "", "description": "Value of the content." }, - { - "name": "modules", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Modules configuration, see [here](https://quilljs.com/docs/modules/) for available options." - }, { "name": "placeholder", "optional": true, @@ -12310,61 +12329,30 @@ "type": "boolean", "default": "false", "description": "Whether to instantiate the editor to readonly mode." - } - ], - "methods": [] - }, - "EditorSelectionChangeEvent": { - "description": "Custom selection change event.", - "relatedProp": "EditorEmits['selection-change']", - "props": [ - { - "name": "htmlValue", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Current value as html." }, { - "name": "instance", - "optional": false, + "name": "formats", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Whitelist of formats to display, see [here](https://quilljs.com/docs/formats/) for available options." + }, + { + "name": "editorStyle", + "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Text editor instance." + "description": "Inline style of the container." }, { - "name": "oldRange", - "optional": false, + "name": "modules", + "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Representation of the previous selection boundaries." - }, - { - "name": "range", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Representation of the selection boundaries." - }, - { - "name": "source", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Source of change. Will be either 'user' or 'api'." - }, - { - "name": "textValue", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Current value as text." + "description": "Modules configuration, see [here](https://quilljs.com/docs/modules/) for available options." } ], "methods": [] @@ -12383,52 +12371,64 @@ ], "methods": [] }, - "EditorTextChangeEvent": { - "description": "Custom text change event.", - "relatedProp": "EditorEmits['text-change']", - "props": [ + "EditorEmits": { + "description": "Defines valid emits in Editor component.", + "relatedProp": "", + "props": [], + "methods": [ { - "name": "delta", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Representation of the change." + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." }, { - "name": "htmlValue", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Current value as html." + "name": "text-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "EditorTextChangeEvent", + "description": "Custom text change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when text of editor changes." }, { - "name": "instance", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Text editor instance." + "name": "selection-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "EditorSelectionChangeEvent", + "description": "Custom selection change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when selection of the text changes." }, { - "name": "source", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Source of change. Will be either 'user' or 'api'." - }, - { - "name": "textValue", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Current value as text." + "name": "load", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "EditorLoadEvent", + "description": "Custom load event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the quill modules are loaded." } - ], - "methods": [] + ] } } } @@ -12450,52 +12450,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "FieldsetEmits": { - "description": "Defines valid emits in Fildset component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "toggle", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FieldsetToggleEvent", - "description": "Custom toggle event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a tab gets expanded or collapsed." - }, - { - "name": "update:collapsed", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the collapsed changes." - } - ] - }, - "FieldsetPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "FieldsetPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -12517,17 +12471,40 @@ ], "methods": [] }, + "FieldsetToggleEvent": { + "description": "Custom toggle event.", + "relatedProp": "FieldsetEmits.toggle", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Collapsed state as a boolean" + } + ], + "methods": [] + }, "FieldsetPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "FieldsetProps.pt", "props": [ { - "name": "content", + "name": "root", "optional": true, "readonly": false, "type": "FieldsetPassThroughOptionType", "default": "", - "description": "Uses to pass attributes to the content's DOM element." + "description": "Uses to pass attributes to the root's DOM element." }, { "name": "legend", @@ -12545,22 +12522,6 @@ "default": "", "description": "Uses to pass attributes to the legend title's DOM element." }, - { - "name": "root", - "optional": true, - "readonly": false, - "type": "FieldsetPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the root's DOM element." - }, - { - "name": "toggleablecontent", - "optional": true, - "readonly": false, - "type": "FieldsetPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the toggleable content's DOM element." - }, { "name": "toggler", "optional": true, @@ -12576,6 +12537,50 @@ "type": "FieldsetPassThroughOptionType", "default": "", "description": "Uses to pass attributes to the toggler icon's DOM element." + }, + { + "name": "toggleablecontent", + "optional": true, + "readonly": false, + "type": "FieldsetPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the toggleable content's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "FieldsetPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + } + ], + "methods": [] + }, + "FieldsetPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "FieldsetState": { + "description": "Defines current inline state in Fieldset component.", + "relatedProp": "", + "props": [ + { + "name": "d_collapsed", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current collapsed state as a boolean." } ], "methods": [] @@ -12584,14 +12589,6 @@ "description": "Defines valid properties in Fieldset component.", "relatedProp": "", "props": [ - { - "name": "collapsed", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines the default visibility state of the content." - }, { "name": "legend", "optional": true, @@ -12601,12 +12598,20 @@ "description": "Header text of the fieldset." }, { - "name": "pt", + "name": "toggleable", "optional": true, "readonly": false, - "type": "FieldsetPassThroughOptions", - "default": "", - "description": "Uses to pass attributes to DOM elements inside the component." + "type": "boolean", + "default": "false", + "description": "When specified, content can toggled by clicking the legend." + }, + { + "name": "collapsed", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines the default visibility state of the content." }, { "name": "toggleButtonProps", @@ -12618,12 +12623,12 @@ "deprecated": "since v3.26.0. Use 'pt' property instead." }, { - "name": "toggleable", + "name": "pt", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, content can toggled by clicking the legend." + "type": "FieldsetPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -12656,43 +12661,38 @@ ], "methods": [] }, - "FieldsetState": { - "description": "Defines current inline state in Fieldset component.", + "FieldsetEmits": { + "description": "Defines valid emits in Fildset component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { - "name": "d_collapsed", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current collapsed state as a boolean." - } - ], - "methods": [] - }, - "FieldsetToggleEvent": { - "description": "Custom toggle event.", - "relatedProp": "FieldsetEmits.toggle", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." + "name": "update:collapsed", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the collapsed changes." }, { - "name": "value", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Collapsed state as a boolean" + "name": "toggle", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FieldsetToggleEvent", + "description": "Custom toggle event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a tab gets expanded or collapsed." } - ], - "methods": [] + ] } } }, @@ -12722,25 +12722,25 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "FileUploadBeforeSendEvent": { - "description": "Custom before send event.", - "relatedProp": "FileUploadEmits['before-send']", + "FileUploadSelectEvent": { + "description": "Custom select event.", + "relatedProp": "FileUploadEmits.select", "props": [ { - "name": "formData", + "name": "originalEvent", "optional": false, "readonly": false, - "type": "FormData", + "type": "Event", "default": "", - "description": "FormData object." + "description": "Browser event." }, { - "name": "xhr", + "name": "files", "optional": false, "readonly": false, - "type": "XMLHttpRequest", + "type": "any", "default": "", - "description": "XmlHttpRequest instance." + "description": "List of selected files." } ], "methods": [] @@ -12749,6 +12749,14 @@ "description": "Custom before upload event.", "relatedProp": "FileUploadEmits['before-upload']", "props": [ + { + "name": "xhr", + "optional": false, + "readonly": false, + "type": "XMLHttpRequest", + "default": "", + "description": "XmlHttpRequest instance." + }, { "name": "formData", "optional": false, @@ -12756,166 +12764,6 @@ "type": "FormData", "default": "", "description": "FormData object." - }, - { - "name": "xhr", - "optional": false, - "readonly": false, - "type": "XMLHttpRequest", - "default": "", - "description": "XmlHttpRequest instance." - } - ], - "methods": [] - }, - "FileUploadEmits": { - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "before-send", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadBeforeSendEvent", - "description": "Custom before send event." - } - ], - "returnType": "void", - "description": "Callback to invoke before file send begins to customize the request such as adding headers." - }, - { - "name": "before-upload", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadBeforeUploadEvent", - "description": "Custom before upload event." - } - ], - "returnType": "void", - "description": "Callback to invoke before file upload begins to customize the request such as post parameters before the files." - }, - { - "name": "clear", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when files in queue are removed without uploading." - }, - { - "name": "error", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadErrorEvent", - "description": "Custom error event." - } - ], - "returnType": "void", - "description": "Callback to invoke if file upload fails." - }, - { - "name": "progress", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadProgressEvent", - "description": "Custom progress event." - } - ], - "returnType": "void", - "description": "Callback to invoke when files are being uploaded." - }, - { - "name": "remove", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadRemoveEvent", - "description": "Custom remove event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a singe file is removed from the list." - }, - { - "name": "removeUploadedFile", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadRemoveUploadedFile", - "description": "Custom uploaded file remove event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a single uploaded file is removed from the uploaded file list." - }, - { - "name": "select", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadSelectEvent", - "description": "Custom select event." - } - ], - "returnType": "void", - "description": "Callback to invoke when files are selected." - }, - { - "name": "upload", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadUploadEvent", - "description": "Custom upload event." - } - ], - "returnType": "void", - "description": "Callback to invoke when file upload is complete." - }, - { - "name": "uploader", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "FileUploadUploaderEvent", - "description": "Custom uploader event." - } - ], - "returnType": "void", - "description": "Callback to invoke to implement a custom upload." - } - ] - }, - "FileUploadErrorEvent": { - "description": "Custom error event.", - "relatedProp": "FileUploadEmits.error", - "props": [ - { - "name": "files", - "optional": false, - "readonly": false, - "type": "File | File[]", - "default": "", - "description": "Files that are not uploaded." - }, - { - "name": "xhr", - "optional": false, - "readonly": false, - "type": "XMLHttpRequest", - "default": "", - "description": "XmlHttpRequest instance." } ], "methods": [] @@ -12943,209 +12791,86 @@ ], "methods": [] }, - "FileUploadProps": { - "description": "Defines valid properties in FileUpload component.", - "relatedProp": "", + "FileUploadUploadEvent": { + "description": "Custom upload event.", + "relatedProp": "FileUploadEmits.upload", "props": [ { - "name": "accept", - "optional": true, + "name": "xhr", + "optional": false, "readonly": false, - "type": "string", + "type": "XMLHttpRequest", "default": "", - "description": "Pattern to restrict the allowed file types such as 'image/*'." + "description": "XmlHttpRequest instance." }, { - "name": "auto", - "optional": true, + "name": "files", + "optional": false, "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, upload begins automatically after selection is completed." - }, - { - "name": "cancelIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-fw pi-times", - "description": "Icon of the cancel button." - }, - { - "name": "cancelLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "Cancel", - "description": "Label of the cancel button. Defaults to PrimeVue Locale configuration." - }, - { - "name": "chooseIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-fw pi-plus", - "description": "Icon of the choose button." - }, - { - "name": "chooseLabel", - "optional": true, - "readonly": false, - "type": "string", + "type": "File | File[]", "default": "", - "description": "Label of the choose button. Defaults to PrimeVue Locale configuration." - }, + "description": "Files that are not uploaded." + } + ], + "methods": [] + }, + "FileUploadUploaderEvent": { + "description": "Custom uploader event.", + "relatedProp": "FileUploadEmits.uploader", + "props": [ { - "name": "class", - "optional": true, + "name": "files", + "optional": false, "readonly": false, - "type": "any", + "type": "File | File[]", "default": "", - "description": "Style class of the component." - }, + "description": "List of selected files." + } + ], + "methods": [] + }, + "FileUploadErrorEvent": { + "description": "Custom error event.", + "relatedProp": "FileUploadEmits.error", + "props": [ { - "name": "customUpload", - "optional": true, + "name": "xhr", + "optional": false, "readonly": false, - "type": "boolean", + "type": "XMLHttpRequest", "default": "", - "description": "Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration." + "description": "XmlHttpRequest instance." }, { - "name": "disabled", - "optional": true, + "name": "files", + "optional": false, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Disables the upload functionality." - }, - { - "name": "fileLimit", - "optional": true, - "readonly": false, - "type": "number", + "type": "File | File[]", "default": "", - "description": "Maximum number of files that can be uploaded." - }, + "description": "Files that are not uploaded." + } + ], + "methods": [] + }, + "FileUploadBeforeSendEvent": { + "description": "Custom before send event.", + "relatedProp": "FileUploadEmits['before-send']", + "props": [ { - "name": "invalidFileLimitMessage", - "optional": true, + "name": "xhr", + "optional": false, "readonly": false, - "type": "string", - "default": "Maximum number of files to be uploaded is {0.}", - "description": "Message to display when number of files to be uploaded exceeeds the limit." - }, - { - "name": "invalidFileSizeMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": ": Invalid file size, file size should be smaller than {1.}", - "description": "Message of the invalid fize size." - }, - { - "name": "invalidFileTypeMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "'{0}: Invalid file type.'", - "description": "Message of the invalid fize type." - }, - { - "name": "maxFileSize", - "optional": true, - "readonly": false, - "type": "number", + "type": "XMLHttpRequest", "default": "", - "description": "Maximum file size allowed in bytes." + "description": "XmlHttpRequest instance." }, { - "name": "mode", - "optional": true, + "name": "formData", + "optional": false, "readonly": false, - "type": "\"basic\" | \"advanced\"", - "default": "advanced", - "description": "Defines the UI of the component, possible values are 'advanced' and 'basic'." - }, - { - "name": "multiple", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Used to select multiple files at once from file dialog." - }, - { - "name": "name", - "optional": true, - "readonly": false, - "type": "string", + "type": "FormData", "default": "", - "description": "Name of the request parameter to identify the files at backend." - }, - { - "name": "previewWidth", - "optional": true, - "readonly": false, - "type": "number", - "default": "50", - "description": "Width of the image thumbnail in pixels." - }, - { - "name": "showCancelButton", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show the cancel button." - }, - { - "name": "showUploadButton", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show the upload button." - }, - { - "name": "style", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the component." - }, - { - "name": "uploadIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-fw pi-upload", - "description": "Icon of the upload button." - }, - { - "name": "uploadLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Label of the upload button. Defaults to PrimeVue Locale configuration." - }, - { - "name": "url", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Remote url to upload the files." - }, - { - "name": "withCredentials", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates." + "description": "FormData object." } ], "methods": [] @@ -13196,25 +12921,209 @@ ], "methods": [] }, - "FileUploadSelectEvent": { - "description": "Custom select event.", - "relatedProp": "FileUploadEmits.select", + "FileUploadProps": { + "description": "Defines valid properties in FileUpload component.", + "relatedProp": "", "props": [ { - "name": "files", - "optional": false, + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the request parameter to identify the files at backend." + }, + { + "name": "url", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Remote url to upload the files." + }, + { + "name": "mode", + "optional": true, + "readonly": false, + "type": "\"basic\" | \"advanced\"", + "default": "advanced", + "description": "Defines the UI of the component, possible values are 'advanced' and 'basic'." + }, + { + "name": "multiple", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Used to select multiple files at once from file dialog." + }, + { + "name": "accept", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Pattern to restrict the allowed file types such as 'image/*'." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Disables the upload functionality." + }, + { + "name": "auto", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, upload begins automatically after selection is completed." + }, + { + "name": "maxFileSize", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Maximum file size allowed in bytes." + }, + { + "name": "invalidFileSizeMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": ": Invalid file size, file size should be smaller than {1.}", + "description": "Message of the invalid fize size." + }, + { + "name": "invalidFileLimitMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "Maximum number of files to be uploaded is {0.}", + "description": "Message to display when number of files to be uploaded exceeeds the limit." + }, + { + "name": "invalidFileTypeMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "'{0}: Invalid file type.'", + "description": "Message of the invalid fize type." + }, + { + "name": "fileLimit", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Maximum number of files that can be uploaded." + }, + { + "name": "withCredentials", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates." + }, + { + "name": "previewWidth", + "optional": true, + "readonly": false, + "type": "number", + "default": "50", + "description": "Width of the image thumbnail in pixels." + }, + { + "name": "chooseLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Label of the choose button. Defaults to PrimeVue Locale configuration." + }, + { + "name": "uploadLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Label of the upload button. Defaults to PrimeVue Locale configuration." + }, + { + "name": "cancelLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "Cancel", + "description": "Label of the cancel button. Defaults to PrimeVue Locale configuration." + }, + { + "name": "customUpload", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration." + }, + { + "name": "showUploadButton", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show the upload button." + }, + { + "name": "showCancelButton", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show the cancel button." + }, + { + "name": "chooseIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-fw pi-plus", + "description": "Icon of the choose button." + }, + { + "name": "uploadIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-fw pi-upload", + "description": "Icon of the upload button." + }, + { + "name": "cancelIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-fw pi-times", + "description": "Icon of the cancel button." + }, + { + "name": "style", + "optional": true, "readonly": false, "type": "any", "default": "", - "description": "List of selected files." + "description": "Inline style of the component." }, { - "name": "originalEvent", - "optional": false, + "name": "class", + "optional": true, "readonly": false, - "type": "Event", + "type": "any", "default": "", - "description": "Browser event." + "description": "Style class of the component." } ], "methods": [] @@ -13224,13 +13133,25 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "header", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t files: File, // Files to upload.\n \t uploadedFiles: File, // Uploaded files.\n \t chooseCallback(): void, // Choose function\n \t uploadCallback(): void, // Upload function\n \t clearCallback(): void, // Clear function\n }" + } + ], + "returnType": "VNode[]", + "description": "Custom header content template." + }, { "name": "content", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t files: File, // Files to upload.\n \t messages: undefined, // Status messages about upload process.\n \t progress: number, // Uploaded progress as number.\n \t uploadedFiles: File, // Uploaded files.\n \t removeFileCallback(index: number): void, // Function to remove a file.\n \t removeUploadedFileCallback(index: number): void, // Function to remove an uploaded file.\n }" + "type": "{\n \t files: File, // Files to upload.\n \t uploadedFiles: File, // Uploaded files.\n \t removeUploadedFileCallback(index: number): void, // Function to remove an uploaded file.\n \t removeFileCallback(index: number): void, // Function to remove a file.\n \t progress: number, // Uploaded progress as number.\n \t messages: undefined, // Status messages about upload process.\n }" } ], "returnType": "VNode[]", @@ -13241,58 +13162,137 @@ "parameters": [], "returnType": "VNode[]", "description": "Custom content when there is no selected file." - }, - { - "name": "header", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t files: File, // Files to upload.\n \t uploadedFiles: File, // Uploaded files.\n \t chooseCallback(): void, // Choose function\n \t clearCallback(): void, // Clear function\n \t uploadCallback(): void, // Upload function\n }" - } - ], - "returnType": "VNode[]", - "description": "Custom header content template." } ] }, - "FileUploadUploadEvent": { - "description": "Custom upload event.", - "relatedProp": "FileUploadEmits.upload", - "props": [ + "FileUploadEmits": { + "relatedProp": "", + "props": [], + "methods": [ { - "name": "files", - "optional": false, - "readonly": false, - "type": "File | File[]", - "default": "", - "description": "Files that are not uploaded." + "name": "select", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadSelectEvent", + "description": "Custom select event." + } + ], + "returnType": "void", + "description": "Callback to invoke when files are selected." }, { - "name": "xhr", - "optional": false, - "readonly": false, - "type": "XMLHttpRequest", - "default": "", - "description": "XmlHttpRequest instance." - } - ], - "methods": [] - }, - "FileUploadUploaderEvent": { - "description": "Custom uploader event.", - "relatedProp": "FileUploadEmits.uploader", - "props": [ + "name": "before-upload", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadBeforeUploadEvent", + "description": "Custom before upload event." + } + ], + "returnType": "void", + "description": "Callback to invoke before file upload begins to customize the request such as post parameters before the files." + }, { - "name": "files", - "optional": false, - "readonly": false, - "type": "File | File[]", - "default": "", - "description": "List of selected files." + "name": "progress", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadProgressEvent", + "description": "Custom progress event." + } + ], + "returnType": "void", + "description": "Callback to invoke when files are being uploaded." + }, + { + "name": "upload", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadUploadEvent", + "description": "Custom upload event." + } + ], + "returnType": "void", + "description": "Callback to invoke when file upload is complete." + }, + { + "name": "uploader", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadUploaderEvent", + "description": "Custom uploader event." + } + ], + "returnType": "void", + "description": "Callback to invoke to implement a custom upload." + }, + { + "name": "error", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadErrorEvent", + "description": "Custom error event." + } + ], + "returnType": "void", + "description": "Callback to invoke if file upload fails." + }, + { + "name": "before-send", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadBeforeSendEvent", + "description": "Custom before send event." + } + ], + "returnType": "void", + "description": "Callback to invoke before file send begins to customize the request such as adding headers." + }, + { + "name": "clear", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when files in queue are removed without uploading." + }, + { + "name": "remove", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadRemoveEvent", + "description": "Custom remove event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a singe file is removed from the list." + }, + { + "name": "removeUploadedFile", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "FileUploadRemoveUploadedFile", + "description": "Custom uploaded file remove event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a single uploaded file is removed from the uploaded file list." } - ], - "methods": [] + ] } } } @@ -13305,6 +13305,21 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "FocusTrapOptions": { + "description": "Defines options of FocusTrap.", + "relatedProp": "", + "props": [ + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the directive should be disabled." + } + ], + "methods": [] + }, "FocusTrapDirectiveBinding": { "description": "Binding of FocusTrap directive.", "relatedProp": "", @@ -13320,21 +13335,6 @@ ], "methods": [], "extendedTypes": "Omit" - }, - "FocusTrapOptions": { - "description": "Defines options of FocusTrap.", - "relatedProp": "", - "props": [ - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the directive should be disabled." - } - ], - "methods": [] } } } @@ -13356,6 +13356,322 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "GalleriaResponsiveOptions": { + "relatedProp": "", + "props": [ + { + "name": "breakpoint", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Breakpoint for responsive mode. Exp;" + }, + { + "name": "numVisible", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "The number of visible items on breakpoint." + } + ], + "methods": [] + }, + "GalleriaProps": { + "description": "Defines valid properties in Galleria component.", + "relatedProp": "", + "props": [ + { + "name": "id", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Unique identifier of the element." + }, + { + "name": "value", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "An array of objects to display." + }, + { + "name": "activeIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Index of the first item." + }, + { + "name": "fullScreen", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to display the component on fullscreen." + }, + { + "name": "visible", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Specifies the visibility of the mask on fullscreen mode." + }, + { + "name": "numVisible", + "optional": true, + "readonly": false, + "type": "number", + "default": "3", + "description": "Number of items per page." + }, + { + "name": "responsiveOptions", + "optional": true, + "readonly": false, + "type": "GalleriaResponsiveOptions[]", + "default": "", + "description": "An array of options for responsive design." + }, + { + "name": "showItemNavigators", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to display navigation buttons in item section." + }, + { + "name": "showThumbnailNavigators", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to display navigation buttons in thumbnail container." + }, + { + "name": "showItemNavigatorsOnHover", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to display navigation buttons on item hover." + }, + { + "name": "changeItemOnIndicatorHover", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, item is changed on indicator hover." + }, + { + "name": "circular", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if scrolling would be infinite." + }, + { + "name": "autoPlay", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Items are displayed with a slideshow in autoPlay mode." + }, + { + "name": "transitionInterval", + "optional": true, + "readonly": false, + "type": "number", + "default": "4000", + "description": "Time in milliseconds to scroll items." + }, + { + "name": "showThumbnails", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to display thumbnail container." + }, + { + "name": "thumbnailsPosition", + "optional": true, + "readonly": false, + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "bottom", + "description": "Position of thumbnails." + }, + { + "name": "verticalThumbnailViewPortHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "300px", + "description": "Height of the viewport in vertical thumbnail." + }, + { + "name": "showIndicators", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to display indicator container." + }, + { + "name": "showIndicatorsOnItem", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, indicator container is displayed on item container." + }, + { + "name": "indicatorsPosition", + "optional": true, + "readonly": false, + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "bottom", + "description": "Position of indicators." + }, + { + "name": "baseZIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Base zIndex value to use in layering." + }, + { + "name": "maskClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the mask on fullscreen mode." + }, + { + "name": "containerStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the component on fullscreen mode. Otherwise, the 'style' property can be used." + }, + { + "name": "containerClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the component on fullscreen mode. Otherwise, the 'class' property can be used." + }, + { + "name": "containerProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLDivElement to the container element on fullscreen mode." + }, + { + "name": "prevButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the previous navigation button." + }, + { + "name": "nextButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the next navigation button." + } + ], + "methods": [] + }, + "GalleriaSlots": { + "description": "Defines valid slots in Galleria slots.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + }, + { + "name": "item", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: any, // Item instance\n }", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." + }, + { + "name": "caption", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: any, // Item instance\n }", + "description": "caption slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom caption template." + }, + { + "name": "indicator", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t index: number, // Index of the indicator item\n }", + "description": "indicator slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom indicator template." + }, + { + "name": "thumbnail", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: any, // Item instance\n }", + "description": "thumbnail slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom thumbnail template." + } + ] + }, "GalleriaEmits": { "description": "Defines valid emits in Galleria component.", "relatedProp": "", @@ -13388,362 +13704,6 @@ "description": "Emitted when the visible changes." } ] - }, - "GalleriaProps": { - "description": "Defines valid properties in Galleria component.", - "relatedProp": "", - "props": [ - { - "name": "activeIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Index of the first item." - }, - { - "name": "autoPlay", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Items are displayed with a slideshow in autoPlay mode." - }, - { - "name": "baseZIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Base zIndex value to use in layering." - }, - { - "name": "changeItemOnIndicatorHover", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, item is changed on indicator hover." - }, - { - "name": "circular", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if scrolling would be infinite." - }, - { - "name": "containerClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the component on fullscreen mode. Otherwise, the 'class' property can be used." - }, - { - "name": "containerProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLDivElement to the container element on fullscreen mode." - }, - { - "name": "containerStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the component on fullscreen mode. Otherwise, the 'style' property can be used." - }, - { - "name": "fullScreen", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to display the component on fullscreen." - }, - { - "name": "id", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Unique identifier of the element." - }, - { - "name": "indicatorsPosition", - "optional": true, - "readonly": false, - "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "bottom", - "description": "Position of indicators." - }, - { - "name": "maskClass", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class of the mask on fullscreen mode." - }, - { - "name": "nextButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the next navigation button." - }, - { - "name": "numVisible", - "optional": true, - "readonly": false, - "type": "number", - "default": "3", - "description": "Number of items per page." - }, - { - "name": "prevButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the previous navigation button." - }, - { - "name": "responsiveOptions", - "optional": true, - "readonly": false, - "type": "GalleriaResponsiveOptions[]", - "default": "", - "description": "An array of options for responsive design." - }, - { - "name": "showIndicators", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to display indicator container." - }, - { - "name": "showIndicatorsOnItem", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, indicator container is displayed on item container." - }, - { - "name": "showItemNavigators", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to display navigation buttons in item section." - }, - { - "name": "showItemNavigatorsOnHover", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to display navigation buttons on item hover." - }, - { - "name": "showThumbnailNavigators", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to display navigation buttons in thumbnail container." - }, - { - "name": "showThumbnails", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to display thumbnail container." - }, - { - "name": "thumbnailsPosition", - "optional": true, - "readonly": false, - "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", - "default": "bottom", - "description": "Position of thumbnails." - }, - { - "name": "transitionInterval", - "optional": true, - "readonly": false, - "type": "number", - "default": "4000", - "description": "Time in milliseconds to scroll items." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "any[]", - "default": "", - "description": "An array of objects to display." - }, - { - "name": "verticalThumbnailViewPortHeight", - "optional": true, - "readonly": false, - "type": "string", - "default": "300px", - "description": "Height of the viewport in vertical thumbnail." - }, - { - "name": "visible", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Specifies the visibility of the mask on fullscreen mode." - } - ], - "methods": [] - }, - "GalleriaResponsiveOptions": { - "relatedProp": "", - "props": [ - { - "name": "breakpoint", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Breakpoint for responsive mode. Exp;" - }, - { - "name": "numVisible", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "The number of visible items on breakpoint." - } - ], - "methods": [] - }, - "GalleriaSlots": { - "description": "Defines valid slots in Galleria slots.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "caption", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t item: any, // Item instance\n }", - "description": "caption slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom caption template." - }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "indicator", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t index: number, // Index of the indicator item\n }", - "description": "indicator slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom indicator template." - }, - { - "name": "item", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t item: any, // Item instance\n }", - "description": "item slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom item template." - }, - { - "name": "thumbnail", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t item: any, // Item instance\n }", - "description": "thumbnail slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom thumbnail template." - } - ] - } - } - } - }, - "icon": { - "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": { - "IconEmits": { - "relatedProp": "", - "props": [], - "methods": [] - }, - "IconProps": { - "relatedProp": "", - "props": [ - { - "name": "label", - "optional": true, - "readonly": false, - "type": "string", - "default": "" - }, - { - "name": "spin", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "" - } - ], - "methods": [] - }, - "IconSlots": { - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -13771,6 +13731,46 @@ "icon/eyeslash": {}, "icon/filter": {}, "icon/filterslash": {}, + "icon": { + "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": { + "IconProps": { + "relatedProp": "", + "props": [ + { + "name": "label", + "optional": true, + "readonly": false, + "type": "string", + "default": "" + }, + { + "name": "spin", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "" + } + ], + "methods": [] + }, + "IconSlots": { + "relatedProp": "", + "props": [], + "methods": [] + }, + "IconEmits": { + "relatedProp": "", + "props": [], + "methods": [] + } + } + } + }, "icon/infocircle": {}, "icon/minus": {}, "icon/pencil": {}, @@ -13802,10 +13802,10 @@ "description": "Defines methods that can be accessed by the component's reference.", "values": [ { - "name": "error", + "name": "show", "parameters": [], "returnType": "void", - "description": "Triggered when an error occurs while loading an image file." + "description": "Triggered when the preview overlay is shown." }, { "name": "hide", @@ -13814,10 +13814,10 @@ "description": "Triggered when the preview overlay is hidden." }, { - "name": "show", + "name": "error", "parameters": [], "returnType": "void", - "description": "Triggered when the preview overlay is shown." + "description": "Triggered when an error occurs while loading an image file." } ] } @@ -13829,22 +13829,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ImageEmits": { - "relatedProp": "", - "props": [], - "methods": [] - }, "ImageProps": { "description": "Defines valid properties in Image component.", "relatedProp": "", "props": [ { - "name": "imageClass", + "name": "preview", "optional": true, "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the image element." + "type": "boolean", + "default": "false", + "description": "Controls the preview functionality." }, { "name": "imageStyle", @@ -13854,6 +13849,14 @@ "default": "", "description": "Inline style of the image element." }, + { + "name": "imageClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the image element." + }, { "name": "indicatorIcon", "optional": true, @@ -13861,14 +13864,6 @@ "type": "string", "default": "pi pi-eye", "description": "Custom indicator icon." - }, - { - "name": "preview", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Controls the preview functionality." } ], "methods": [] @@ -13878,12 +13873,6 @@ "relatedProp": "", "props": [], "methods": [ - { - "name": "close", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom close template." - }, { "name": "indicator", "parameters": [], @@ -13902,6 +13891,12 @@ "returnType": "VNode[]", "description": "Custom undo template." }, + { + "name": "zoomout", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom zoomout template." + }, { "name": "zoomin", "parameters": [], @@ -13909,12 +13904,17 @@ "description": "Custom zoomin template." }, { - "name": "zoomout", + "name": "close", "parameters": [], "returnType": "VNode[]", - "description": "Custom zoomout template." + "description": "Custom close template." } ] + }, + "ImageEmits": { + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -13936,11 +13936,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "InlineMessageEmits": { - "relatedProp": "", - "props": [], - "methods": [] - }, "InlineMessageProps": { "description": "Defines valid properties in InlineMessage component.", "relatedProp": "", @@ -13968,6 +13963,11 @@ "description": "Default custom slot." } ] + }, + "InlineMessageEmits": { + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -13989,23 +13989,97 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "InplaceProps": { + "description": "Defines valid properties in Inplace component.", + "relatedProp": "", + "props": [ + { + "name": "closable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Displays a button to switch back to display mode." + }, + { + "name": "active", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the content is displayed or not." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the element should be disabled." + }, + { + "name": "closeIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times", + "description": "Icon to display in the close button." + }, + { + "name": "displayProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLDivElement to display container." + }, + { + "name": "closeButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the close button." + } + ], + "methods": [] + }, + "InplaceSlots": { + "description": "Defines valid slots in Inplace component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "display", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom display template." + }, + { + "name": "content", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." + } + ] + }, "InplaceEmits": { "description": "Defines valid emits in Inplace component.", "relatedProp": "", "props": [], "methods": [ { - "name": "close", + "name": "update:active", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "Event", - "description": "Browser event." + "type": "boolean", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when inplace is closed." + "description": "Emitted when the active changes." }, { "name": "open", @@ -14021,91 +14095,17 @@ "description": "Callback to invoke when inplace is opened." }, { - "name": "update:active", + "name": "close", "parameters": [ { - "name": "value", + "name": "event", "optional": false, - "type": "boolean", - "description": "New value." + "type": "Event", + "description": "Browser event." } ], "returnType": "void", - "description": "Emitted when the active changes." - } - ] - }, - "InplaceProps": { - "description": "Defines valid properties in Inplace component.", - "relatedProp": "", - "props": [ - { - "name": "active", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the content is displayed or not." - }, - { - "name": "closable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Displays a button to switch back to display mode." - }, - { - "name": "closeButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the close button." - }, - { - "name": "closeIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times", - "description": "Icon to display in the close button." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the element should be disabled." - }, - { - "name": "displayProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLDivElement to display container." - } - ], - "methods": [] - }, - "InplaceSlots": { - "description": "Defines valid slots in Inplace component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "content", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom content template." - }, - { - "name": "display", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom display template." + "description": "Callback to invoke when inplace is closed." } ] } @@ -14129,17 +14129,70 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "InputMaskProps": { + "description": "Defines valid properties in InputMask component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Value of the component." + }, + { + "name": "slotChar", + "optional": true, + "readonly": false, + "type": "string", + "default": "_", + "description": "Placeholder character in mask, default is underscore." + }, + { + "name": "mask", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Mask pattern." + }, + { + "name": "autoClear", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Clears the incomplete value on blur." + }, + { + "name": "unmask", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if model sets the raw unmasked value to bound value or the formatted mask value." + }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the items are clickable or not." + } + ], + "methods": [] + }, + "InputMaskSlots": { + "relatedProp": "", + "props": [], + "methods": [] + }, "InputMaskEmits": { "description": "Defines valid emits in InputMask component.", "relatedProp": "", "props": [ - { - "name": "complete", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - }, { "name": "keypress", "optional": false, @@ -14153,20 +14206,28 @@ "readonly": false, "type": "Function", "default": "" + }, + { + "name": "complete", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" } ], "methods": [ { - "name": "blur", + "name": "update:modelValue", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "Event" + "type": "string", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when the component loses focus." + "description": "Emitted when the value changes." }, { "name": "focus", @@ -14180,6 +14241,18 @@ "returnType": "void", "description": "Callback to invoke when the component receives focus." }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event" + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, { "name": "keydown", "parameters": [ @@ -14191,81 +14264,8 @@ ], "returnType": "void", "description": "Callback to invoke when a key is pressed." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "string", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." } ] - }, - "InputMaskProps": { - "description": "Defines valid properties in InputMask component.", - "relatedProp": "", - "props": [ - { - "name": "autoClear", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Clears the incomplete value on blur." - }, - { - "name": "mask", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Mask pattern." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Value of the component." - }, - { - "name": "readonly", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the items are clickable or not." - }, - { - "name": "slotChar", - "optional": true, - "readonly": false, - "type": "string", - "default": "_", - "description": "Placeholder character in mask, default is underscore." - }, - { - "name": "unmask", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if model sets the raw unmasked value to bound value or the formatted mask value." - } - ], - "methods": [] - }, - "InputMaskSlots": { - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -14287,88 +14287,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "InputNumberBlurEvent": { - "description": "Custom blur event.", - "relatedProp": "InputNumberEmits.blur", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Input value" - } - ], - "methods": [] - }, - "InputNumberEmits": { - "description": "Defines valid emits in InputNumber component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "InputNumberBlurEvent", - "description": "Blur event" - } - ], - "returnType": "void", - "description": "Callback to invoke on blur of input field." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Focus event" - } - ], - "returnType": "void", - "description": "Callback to invoke on focus of input field." - }, - { - "name": "input", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "InputNumberInputEvent", - "description": "Custom input event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the value is entered." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "InputNumberInputEvent": { "description": "Custom input event.", "relatedProp": "InputNumberEmits.input", @@ -14392,89 +14310,40 @@ ], "methods": [] }, + "InputNumberBlurEvent": { + "description": "Custom blur event.", + "relatedProp": "InputNumberEmits.blur", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Input value" + } + ], + "methods": [] + }, "InputNumberProps": { "description": "Defines valid properties in InputNumber component.", "relatedProp": "", "props": [ { - "name": "allowEmpty", + "name": "modelValue", "optional": true, "readonly": false, - "type": "boolean", - "default": "true", - "description": "Determines whether the input field is empty." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", + "type": "Nullable", "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "buttonLayout", - "optional": true, - "readonly": false, - "type": "\"horizontal\" | \"vertical\" | \"stacked\"", - "default": "stacked", - "description": "Layout of the buttons." - }, - { - "name": "currency", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "The currency to use in currency formatting. Possible values are the [ISO 4217 currency codes](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency), such as 'USD' for the US dollar, 'EUR' for the euro, or 'CNY' for the Chinese RMB.\nThere is no default value; if the style is 'currency', the currency property must be provided." - }, - { - "name": "currencyDisplay", - "optional": true, - "readonly": false, - "type": "string", - "default": "symbol", - "description": "How to display the currency in currency formatting. Possible values are 'symbol' to use a localized currency symbol such as €, 'code' to use the ISO currency code, 'name' to use a localized currency name such as 'dollar'." - }, - { - "name": "decrementButtonClass", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class of the decrement button." - }, - { - "name": "decrementButtonIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-angle-down", - "description": "Style class of the decrement button." - }, - { - "name": "decrementButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to decrement button inside the component." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." + "description": "Value of the component." }, { "name": "format", @@ -14485,12 +14354,20 @@ "description": "Whether to format the value." }, { - "name": "highlightOnFocus", + "name": "showButtons", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Highlights automatically the input value." + "description": "Displays spinner buttons." + }, + { + "name": "buttonLayout", + "optional": true, + "readonly": false, + "type": "\"horizontal\" | \"vertical\" | \"stacked\"", + "default": "stacked", + "description": "Layout of the buttons." }, { "name": "incrementButtonClass", @@ -14500,6 +14377,14 @@ "default": "", "description": "Style class of the increment button." }, + { + "name": "decrementButtonClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the decrement button." + }, { "name": "incrementButtonIcon", "optional": true, @@ -14509,44 +14394,12 @@ "description": "Style class of the increment button." }, { - "name": "incrementButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to increment button inside the component." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", + "name": "decrementButtonIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Identifier of the focus input to match a label defined for the chips." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." + "default": "pi pi-angle-down", + "description": "Style class of the decrement button." }, { "name": "locale", @@ -14565,12 +14418,60 @@ "description": "The locale matching algorithm to use. Possible values are 'lookup' and 'best fit'; the default is 'best fit'.\nSee [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details." }, { - "name": "max", + "name": "mode", + "optional": true, + "readonly": false, + "type": "\"decimal\" | \"currency\"", + "default": "decimal", + "description": "Defines the behavior of the component." + }, + { + "name": "prefix", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text to display before the value." + }, + { + "name": "suffix", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text to display after the value." + }, + { + "name": "currency", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The currency to use in currency formatting. Possible values are the [ISO 4217 currency codes](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency), such as 'USD' for the US dollar, 'EUR' for the euro, or 'CNY' for the Chinese RMB.\nThere is no default value; if the style is 'currency', the currency property must be provided." + }, + { + "name": "currencyDisplay", + "optional": true, + "readonly": false, + "type": "string", + "default": "symbol", + "description": "How to display the currency in currency formatting. Possible values are 'symbol' to use a localized currency symbol such as €, 'code' to use the ISO currency code, 'name' to use a localized currency name such as 'dollar'." + }, + { + "name": "useGrouping", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators." + }, + { + "name": "minFractionDigits", "optional": true, "readonly": false, "type": "number", "default": "", - "description": "Maximum boundary value." + "description": "The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0;\nthe default for currency formatting is the number of minor unit digits provided by the [ISO 4217 currency code](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) list (2 if the list doesn't provide that information)." }, { "name": "maxFractionDigits", @@ -14589,60 +14490,12 @@ "description": "Mininum boundary value." }, { - "name": "minFractionDigits", + "name": "max", "optional": true, "readonly": false, "type": "number", "default": "", - "description": "The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0;\nthe default for currency formatting is the number of minor unit digits provided by the [ISO 4217 currency code](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) list (2 if the list doesn't provide that information)." - }, - { - "name": "mode", - "optional": true, - "readonly": false, - "type": "\"decimal\" | \"currency\"", - "default": "decimal", - "description": "Defines the behavior of the component." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "Nullable", - "default": "", - "description": "Value of the component." - }, - { - "name": "placeholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text for the input." - }, - { - "name": "prefix", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Text to display before the value." - }, - { - "name": "readonly", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that an input field is read-only." - }, - { - "name": "showButtons", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Displays spinner buttons." + "description": "Maximum boundary value." }, { "name": "step", @@ -14653,20 +14506,108 @@ "description": "Step factor to increment/decrement the value." }, { - "name": "suffix", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Text to display after the value." - }, - { - "name": "useGrouping", + "name": "allowEmpty", "optional": true, "readonly": false, "type": "boolean", "default": "true", - "description": "Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators." + "description": "Determines whether the input field is empty." + }, + { + "name": "highlightOnFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Highlights automatically the input value." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that an input field is read-only." + }, + { + "name": "placeholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Placeholder text for the input." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the focus input to match a label defined for the chips." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "incrementButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to increment button inside the component." + }, + { + "name": "decrementButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to decrement button inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." } ], "methods": [] @@ -14676,6 +14617,65 @@ "relatedProp": "", "props": [], "methods": [] + }, + "InputNumberEmits": { + "description": "Defines valid emits in InputNumber component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "input", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "InputNumberInputEvent", + "description": "Custom input event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the value is entered." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Focus event" + } + ], + "returnType": "void", + "description": "Callback to invoke on focus of input field." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "InputNumberBlurEvent", + "description": "Blur event" + } + ], + "returnType": "void", + "description": "Callback to invoke on blur of input field." + } + ] } } } @@ -14697,125 +14697,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "InputSwitchEmits": { - "description": "Defines valid emits in InputSwitch component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke on click." - }, - { - "name": "input", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "InputSwitchProps": { "description": "Defines valid properties in InputSwitch component.", "relatedProp": "", "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "falseValue", - "optional": true, - "readonly": false, - "type": "any", - "default": "false", - "description": "Value in unchecked state." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, { "name": "modelValue", "optional": true, @@ -14831,6 +14716,62 @@ "type": "any", "default": "true", "description": "Value in checked state." + }, + { + "name": "falseValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "false", + "description": "Value in unchecked state." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." } ], "methods": [] @@ -14839,6 +14780,65 @@ "relatedProp": "", "props": [], "methods": [] + }, + "InputSwitchEmits": { + "description": "Defines valid emits in InputSwitch component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on click." + }, + { + "name": "change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "input", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + } + ] } } } @@ -14860,26 +14860,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "InputTextEmits": { - "description": "Defines valid emits in InputText component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "undefined | string", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "InputTextProps": { "description": "Defines valid properties in InputText component.", "relatedProp": "", @@ -14901,6 +14881,26 @@ "relatedProp": "", "props": [], "methods": [] + }, + "InputTextEmits": { + "description": "Defines valid emits in InputText component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "undefined | string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] } } } @@ -14913,23 +14913,152 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "KnobProps": { + "description": "Defines valid properties in Knob component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Value of the component." + }, + { + "name": "size", + "optional": true, + "readonly": false, + "type": "number", + "default": "100", + "description": "Size of the component in pixels." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component value cannot be edited." + }, + { + "name": "step", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Step factor to increment/decrement the value." + }, + { + "name": "min", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Mininum boundary value." + }, + { + "name": "max", + "optional": true, + "readonly": false, + "type": "number", + "default": "100", + "description": "Maximum boundary value." + }, + { + "name": "valueColor", + "optional": true, + "readonly": false, + "type": "string", + "default": "var(--primary-color, Black)", + "description": "Background of the value." + }, + { + "name": "rangeColor", + "optional": true, + "readonly": false, + "type": "string", + "default": "var(--surface-border, LightGray)", + "description": "Background color of the range." + }, + { + "name": "textColor", + "optional": true, + "readonly": false, + "type": "string", + "default": "var(--text-color-secondary, Black)", + "description": "Color of the value text." + }, + { + "name": "strokeWidth", + "optional": true, + "readonly": false, + "type": "number", + "default": "14", + "description": "Width of the knob stroke." + }, + { + "name": "showValue", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether the show the value inside the knob." + }, + { + "name": "valueTemplate", + "optional": true, + "readonly": false, + "type": "string", + "default": "'{value}'", + "description": "Template string of the value." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Index of the element in tabbing order." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Used to define a string that labels the element." + } + ], + "methods": [] + }, + "KnobSlots": { + "description": "Defines valid slots in Knob component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "KnobEmits": { "description": "Defines valid emits in Knob component.", "relatedProp": "", "props": [], "methods": [ - { - "name": "change", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number" - } - ], - "returnType": "void", - "description": "Callback to invoke when the value changes." - }, { "name": "update:modelValue", "parameters": [ @@ -14941,149 +15070,20 @@ ], "returnType": "void", "description": "Emitted when the value changes." + }, + { + "name": "change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number" + } + ], + "returnType": "void", + "description": "Callback to invoke when the value changes." } ] - }, - "KnobProps": { - "description": "Defines valid properties in Knob component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Used to define a string that labels the element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "max", - "optional": true, - "readonly": false, - "type": "number", - "default": "100", - "description": "Maximum boundary value." - }, - { - "name": "min", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Mininum boundary value." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Value of the component." - }, - { - "name": "rangeColor", - "optional": true, - "readonly": false, - "type": "string", - "default": "var(--surface-border, LightGray)", - "description": "Background color of the range." - }, - { - "name": "readonly", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component value cannot be edited." - }, - { - "name": "showValue", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether the show the value inside the knob." - }, - { - "name": "size", - "optional": true, - "readonly": false, - "type": "number", - "default": "100", - "description": "Size of the component in pixels." - }, - { - "name": "step", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Step factor to increment/decrement the value." - }, - { - "name": "strokeWidth", - "optional": true, - "readonly": false, - "type": "number", - "default": "14", - "description": "Width of the knob stroke." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Index of the element in tabbing order." - }, - { - "name": "textColor", - "optional": true, - "readonly": false, - "type": "string", - "default": "var(--text-color-secondary, Black)", - "description": "Color of the value text." - }, - { - "name": "valueColor", - "optional": true, - "readonly": false, - "type": "string", - "default": "var(--primary-color, Black)", - "description": "Background of the value." - }, - { - "name": "valueTemplate", - "optional": true, - "readonly": false, - "type": "string", - "default": "'{value}'", - "description": "Template string of the value." - } - ], - "methods": [] - }, - "KnobSlots": { - "description": "Defines valid slots in Knob component.", - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -15128,78 +15128,6 @@ ], "methods": [] }, - "ListboxEmits": { - "description": "Defines valid emits in Listbox component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "ListboxChangeEvent", - "description": "Custom change event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "filter", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "ListboxFilterEvent", - "description": "Custom filter event." - } - ], - "returnType": "void", - "description": "Callback to invoke on filter input." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "ListboxFilterEvent": { "description": "Custom filter event.", "relatedProp": "ListboxEmits.filter", @@ -15227,150 +15155,6 @@ "description": "Defines valid properties in Listbox component.", "relatedProp": "", "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "autoOptionFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to focus on the first visible or selected element." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "A property to uniquely identify an option." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, disables the component." - }, - { - "name": "emptyFilterMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptyMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptySelectionMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No selected item", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "filter", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, displays a filter input at header." - }, - { - "name": "filterFields", - "optional": true, - "readonly": false, - "type": "string[]", - "default": "", - "description": "Fields used when filtering the options, defaults to optionLabel." - }, - { - "name": "filterIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "ß", - "description": "Icon to display in filter input." - }, - { - "name": "filterInputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the filter input inside the component." - }, - { - "name": "filterLocale", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Locale to use in filtering. The default locale is the host environment's current locale." - }, - { - "name": "filterMatchMode", - "optional": true, - "readonly": false, - "type": "string", - "default": "contains", - "description": "Defines the filtering algorithm to use when searching the options." - }, - { - "name": "filterMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "'{0} results are available'", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "filterPlaceholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text to show when filter input is empty." - }, - { - "name": "listStyle", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Inline style of inner list element." - }, - { - "name": "metaKeySelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." - }, { "name": "modelValue", "optional": true, @@ -15380,36 +15164,12 @@ "description": "Value of the component." }, { - "name": "multiple", + "name": "options", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, allows selecting multiple values." - }, - { - "name": "optionDisabled", - "optional": true, - "readonly": false, - "type": "string | Function", + "type": "any[]", "default": "", - "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." - }, - { - "name": "optionGroupChildren", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function that refers to the children options of option group." - }, - { - "name": "optionGroupLabel", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the label of an option group." + "description": "An array of selectitems to display as the available options." }, { "name": "optionLabel", @@ -15428,12 +15188,132 @@ "description": "Property name or getter function to use as the value of an option, defaults to the option itself when not defined." }, { - "name": "options", + "name": "optionDisabled", "optional": true, "readonly": false, - "type": "any[]", + "type": "string | Function", "default": "", - "description": "An array of selectitems to display as the available options." + "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." + }, + { + "name": "optionGroupLabel", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function to use as the label of an option group." + }, + { + "name": "optionGroupChildren", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function that refers to the children options of option group." + }, + { + "name": "listStyle", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Inline style of inner list element." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, disables the component." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "A property to uniquely identify an option." + }, + { + "name": "multiple", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, allows selecting multiple values." + }, + { + "name": "metaKeySelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." + }, + { + "name": "filter", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, displays a filter input at header." + }, + { + "name": "filterPlaceholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Placeholder text to show when filter input is empty." + }, + { + "name": "filterLocale", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Locale to use in filtering. The default locale is the host environment's current locale." + }, + { + "name": "filterMatchMode", + "optional": true, + "readonly": false, + "type": "string", + "default": "contains", + "description": "Defines the filtering algorithm to use when searching the options." + }, + { + "name": "filterFields", + "optional": true, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Fields used when filtering the options, defaults to optionLabel." + }, + { + "name": "filterInputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the filter input inside the component." + }, + { + "name": "virtualScrollerOptions", + "optional": true, + "readonly": false, + "type": "VirtualScrollerProps", + "default": "", + "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it." + }, + { + "name": "autoOptionFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to focus on the first visible or selected element." }, { "name": "selectOnFocus", @@ -15443,6 +15323,14 @@ "default": "false", "description": "When enabled, the focused option is selected." }, + { + "name": "filterMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "'{0} results are available'", + "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." + }, { "name": "selectionMessage", "optional": true, @@ -15451,6 +15339,30 @@ "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, + { + "name": "emptySelectionMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No selected item", + "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptyFilterMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found", + "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptyMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found", + "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." + }, { "name": "tabindex", "optional": true, @@ -15460,12 +15372,28 @@ "description": "Index of the element in tabbing order." }, { - "name": "virtualScrollerOptions", + "name": "filterIcon", "optional": true, "readonly": false, - "type": "VirtualScrollerProps", + "type": "string", + "default": "ß", + "description": "Icon to display in filter input." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", "default": "", - "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it." + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." } ], "methods": [] @@ -15475,6 +15403,70 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "header", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t options: any, // Displayed options\n }", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t options: any, // Displayed options\n }", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template." + }, + { + "name": "option", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." + }, + { + "name": "optiongroup", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "optiongroup slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom optiongroup template." + }, + { + "name": "emptyfilter", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom emptyfilter template." + }, + { + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." + }, { "name": "content", "parameters": [ @@ -15488,44 +15480,6 @@ "returnType": "VNode[]", "description": "Custom content template." }, - { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template." - }, - { - "name": "emptyfilter", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom emptyfilter template." - }, - { - "name": "footer", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "footer slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "header slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom header template." - }, { "name": "loader", "parameters": [ @@ -15538,32 +15492,78 @@ ], "returnType": "VNode[]", "description": "Custom loader template." - }, + } + ] + }, + "ListboxEmits": { + "description": "Defines valid emits in Listbox component.", + "relatedProp": "", + "props": [], + "methods": [ { - "name": "option", + "name": "update:modelValue", "parameters": [ { - "name": "scope", + "name": "value", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "option slot's params." + "type": "any", + "description": "New value." } ], - "returnType": "VNode[]", - "description": "Custom option template." + "returnType": "void", + "description": "Emitted when the value changes." }, { - "name": "optiongroup", + "name": "change", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "optiongroup slot's params." + "type": "ListboxChangeEvent", + "description": "Custom change event." } ], - "returnType": "VNode[]", - "description": "Custom optiongroup template." + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "filter", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "ListboxFilterEvent", + "description": "Custom filter event." + } + ], + "returnType": "void", + "description": "Callback to invoke on filter input." } ] } @@ -15587,75 +15587,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "MegaMenuEmits": { - "description": "Defines valid emits in MegaMenu component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - } - ] - }, "MegaMenuProps": { "description": "Defines valid properties in MegaMenu component.", "relatedProp": "", "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying menu element." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "exact", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." - }, { "name": "model", "optional": true, @@ -15672,6 +15607,22 @@ "default": "horizontal", "description": "Defines the orientation." }, + { + "name": "exact", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, { "name": "tabindex", "optional": true, @@ -15679,6 +15630,22 @@ "type": "string | number", "default": "", "description": "Index of the element in tabbing order." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying menu element." } ], "methods": [] @@ -15688,6 +15655,12 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "start", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." + }, { "name": "end", "parameters": [], @@ -15706,12 +15679,39 @@ ], "returnType": "VNode[]", "description": "Custom item template." + } + ] + }, + "MegaMenuEmits": { + "description": "Defines valid emits in MegaMenu component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." }, { - "name": "start", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom start template." + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." } ] } @@ -15727,10 +15727,16 @@ "description": "Defines methods that can be accessed by the component's reference.", "values": [ { - "name": "hide", - "parameters": [], + "name": "toggle", + "parameters": [ + { + "name": "event", + "type": "Event", + "description": "Browser event." + } + ], "returnType": "void", - "description": "Hides the overlay." + "description": "Toggles the visibility of the overlay." }, { "name": "show", @@ -15750,16 +15756,10 @@ "description": "Shows the overlay." }, { - "name": "toggle", - "parameters": [ - { - "name": "event", - "type": "Event", - "description": "Browser event." - } - ], + "name": "hide", + "parameters": [], "returnType": "void", - "description": "Toggles the visibility of the overlay." + "description": "Hides the overlay." } ] } @@ -15771,43 +15771,26 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "MenuEmits": { - "description": "Defines valid emits in Menu component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - } - ] - }, "MenuProps": { "description": "Defines valid properties in Menu component.", "relatedProp": "", "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "An array of menuitems." + }, + { + "name": "popup", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if menu would displayed as a popup." + }, { "name": "appendTo", "optional": true, @@ -15816,22 +15799,6 @@ "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, { "name": "autoZIndex", "optional": true, @@ -15856,22 +15823,6 @@ "default": "true", "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, - { - "name": "model", - "optional": true, - "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "An array of menuitems." - }, - { - "name": "popup", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if menu would displayed as a popup." - }, { "name": "tabindex", "optional": true, @@ -15879,6 +15830,22 @@ "type": "string | number", "default": "", "description": "Index of the element in tabbing order." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." } ], "methods": [] @@ -15888,6 +15855,12 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "start", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." + }, { "name": "end", "parameters": [], @@ -15906,12 +15879,39 @@ ], "returnType": "VNode[]", "description": "Custom item template." + } + ] + }, + "MenuEmits": { + "description": "Defines valid emits in Menu component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." }, { - "name": "start", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom start template." + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." } ] } @@ -15935,16 +15935,34 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "MenubarEmits": { - "description": "Defines valid emits in Menubar component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "MenubarProps": { "description": "Defines valid properties in Menubar component.", "relatedProp": "", "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "An array of menuitems." + }, + { + "name": "exact", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." + }, + { + "name": "buttonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the menu button." + }, { "name": "aria-label", "optional": true, @@ -15960,30 +15978,6 @@ "type": "string", "default": "", "description": "Identifier of the underlying input element." - }, - { - "name": "buttonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the menu button." - }, - { - "name": "exact", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." - }, - { - "name": "model", - "optional": true, - "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "An array of menuitems." } ], "methods": [] @@ -15993,6 +15987,12 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "start", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." + }, { "name": "end", "parameters": [], @@ -16011,14 +16011,14 @@ ], "returnType": "VNode[]", "description": "Custom item template." - }, - { - "name": "start", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom start template." } ] + }, + "MenubarEmits": { + "description": "Defines valid emits in Menubar component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -16031,32 +16031,46 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "MenuItemCommandEvent": { + "description": "Custom command event.", + "relatedProp": "", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "item", + "optional": false, + "readonly": false, + "type": "MenuItem", + "default": "", + "description": "Menuitem instance." + }, + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, "MenuItem": { "description": "Defines model of MenuItem API.", "relatedProp": "", "props": [ { - "name": "class", + "name": "label", "optional": true, "readonly": false, - "type": "any", + "type": "string | Function", "default": "", - "description": "Style class of the menuitem." - }, - { - "name": "command", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean | Function", - "default": "false", - "description": "A boolean or a function to return a boolean to specify if the item is disabled." + "description": "Property name or getter function to use as the label of an item." }, { "name": "icon", @@ -16066,6 +16080,29 @@ "default": "", "description": "Icon of the item." }, + { + "name": "to", + "optional": true, + "readonly": false, + "type": "RouteLocationRaw", + "default": "", + "description": "Route configuration such as path, name and parameters." + }, + { + "name": "command", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "url", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "External link to navigate when item is clicked." + }, { "name": "items", "optional": true, @@ -16075,20 +16112,28 @@ "description": "An array of children menuitems." }, { - "name": "key", + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean | Function", + "default": "false", + "description": "A boolean or a function to return a boolean to specify if the item is disabled." + }, + { + "name": "visible", + "optional": true, + "readonly": false, + "type": "boolean | Function", + "default": "true", + "description": "A boolean or a function to return a boolean to specify if the item is visible." + }, + { + "name": "target", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Unique identifier of an item." - }, - { - "name": "label", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the label of an item." + "description": "Specifies where to open the linked document." }, { "name": "separator", @@ -16107,65 +16152,20 @@ "description": "Inline style of the menuitem." }, { - "name": "target", + "name": "class", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the menuitem." + }, + { + "name": "key", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Specifies where to open the linked document." - }, - { - "name": "to", - "optional": true, - "readonly": false, - "type": "RouteLocationRaw", - "default": "", - "description": "Route configuration such as path, name and parameters." - }, - { - "name": "url", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "External link to navigate when item is clicked." - }, - { - "name": "visible", - "optional": true, - "readonly": false, - "type": "boolean | Function", - "default": "true", - "description": "A boolean or a function to return a boolean to specify if the item is visible." - }, - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, - "MenuItemCommandEvent": { - "description": "Custom command event.", - "relatedProp": "", - "props": [ - { - "name": "item", - "optional": false, - "readonly": false, - "type": "MenuItem", - "default": "", - "description": "Menuitem instance." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." + "description": "Unique identifier of an item." }, { "name": "[key: string]", @@ -16196,6 +16196,82 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "MessageProps": { + "description": "Defines valid properties in Message component.", + "relatedProp": "", + "props": [ + { + "name": "severity", + "optional": true, + "readonly": false, + "type": "string", + "default": "info", + "description": "Severity level of the message." + }, + { + "name": "closable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether the message can be closed manually using the close icon." + }, + { + "name": "sticky", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "When enabled, message is not removed automatically." + }, + { + "name": "life", + "optional": true, + "readonly": false, + "type": "number", + "default": "3000", + "description": "Delay in milliseconds to close the message automatically." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Display a custom icon for the message." + }, + { + "name": "closeIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times", + "description": "Icon to display in the message close button." + }, + { + "name": "closeButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the close button." + } + ], + "methods": [] + }, + "MessageSlots": { + "description": "Defines valid slots in Message slots.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "default", + "parameters": [], + "returnType": "VNode[]", + "description": "Default custom slot." + } + ] + }, "MessageEmits": { "description": "Defines valid emits in Message component.", "relatedProp": "", @@ -16215,82 +16291,6 @@ "description": "Callback to invoke when a message is closed." } ] - }, - "MessageProps": { - "description": "Defines valid properties in Message component.", - "relatedProp": "", - "props": [ - { - "name": "closable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether the message can be closed manually using the close icon." - }, - { - "name": "closeButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the close button." - }, - { - "name": "closeIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times", - "description": "Icon to display in the message close button." - }, - { - "name": "icon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Display a custom icon for the message." - }, - { - "name": "life", - "optional": true, - "readonly": false, - "type": "number", - "default": "3000", - "description": "Delay in milliseconds to close the message automatically." - }, - { - "name": "severity", - "optional": true, - "readonly": false, - "type": "string", - "default": "info", - "description": "Severity level of the message." - }, - { - "name": "sticky", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "When enabled, message is not removed automatically." - } - ], - "methods": [] - }, - "MessageSlots": { - "description": "Defines valid slots in Message slots.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "default", - "parameters": [], - "returnType": "VNode[]", - "description": "Default custom slot." - } - ] } } } @@ -16303,18 +16303,6 @@ "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [ - { - "name": "hide", - "parameters": [ - { - "name": "isFocus", - "type": "boolean", - "description": "Decides whether to focus on the component. Default value is false." - } - ], - "returnType": "void", - "description": "Hides the overlay." - }, { "name": "show", "parameters": [ @@ -16326,6 +16314,18 @@ ], "returnType": "void", "description": "Shows the overlay." + }, + { + "name": "hide", + "parameters": [ + { + "name": "isFocus", + "type": "boolean", + "description": "Decides whether to focus on the component. Default value is false." + } + ], + "returnType": "void", + "description": "Hides the overlay." } ] } @@ -16337,29 +16337,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "MultiSelectAllChangeEvent": { - "description": "Custom all change event.", - "relatedProp": "MultiSelectEmits['selectall-change']", - "props": [ - { - "name": "checked", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether all data is selected." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [] - }, "MultiSelectChangeEvent": { "description": "Custom change event.", "relatedProp": "MultiSelectEmits.change", @@ -16383,114 +16360,28 @@ ], "methods": [] }, - "MultiSelectEmits": { - "description": "Defines valid emits in MultiSelect component.", - "relatedProp": "", - "props": [], - "methods": [ + "MultiSelectAllChangeEvent": { + "description": "Custom all change event.", + "relatedProp": "MultiSelectEmits['selectall-change']", + "props": [ { - "name": "before-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is hidden." + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" }, { - "name": "before-show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is shown." - }, - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "MultiSelectChangeEvent", - "description": "Custom change event." - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "filter", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "MultiSelectFilterEvent", - "description": "Custom filter event." - } - ], - "returnType": "void", - "description": "Callback to invoke on filter input." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is hidden." - }, - { - "name": "selectall-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "MultiSelectAllChangeEvent", - "description": "Custom select all change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when all data is selected." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is shown." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." + "name": "checked", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether all data is selected." } - ] + ], + "methods": [] }, "MultiSelectFilterEvent": { "description": "Custom filter event", @@ -16519,230 +16410,6 @@ "description": "Defines valid properties in MultiSelect component.", "relatedProp": "", "props": [ - { - "name": "appendTo", - "optional": true, - "readonly": false, - "type": "string | HTMLElement", - "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." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "autoFilterFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to focus on the filter element when the overlay panel is shown." - }, - { - "name": "autoOptionFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." - }, - { - "name": "checkboxIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-check", - "description": "Icon to display in the checkboxes." - }, - { - "name": "closeButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the clear button inside the overlay panel." - }, - { - "name": "closeIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times", - "description": "Icon to display in the dropdown close button." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "A property to uniquely identify an option." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "display", - "optional": true, - "readonly": false, - "type": "\"comma\" | \"chip\"", - "default": "comma", - "description": "Defines how the selected items are displayed." - }, - { - "name": "dropdownIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-down", - "description": "Icon to display in the dropdown." - }, - { - "name": "emptyFilterMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptyMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found'", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "emptySelectionMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No selected item", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "filter", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, displays a filter input at header." - }, - { - "name": "filterFields", - "optional": true, - "readonly": false, - "type": "string[]", - "default": "", - "description": "Fields used when filtering the options, defaults to optionLabel." - }, - { - "name": "filterIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-search", - "description": "Icon to display in filter input." - }, - { - "name": "filterInputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the filter input inside the overlay panel." - }, - { - "name": "filterLocale", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Locale to use in filtering. The default locale is the host environment's current locale." - }, - { - "name": "filterMatchMode", - "optional": true, - "readonly": false, - "type": "string", - "default": "contains", - "description": "Defines the filtering algorithm to use when searching the options." - }, - { - "name": "filterMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "'{0} results are available'", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "filterPlaceholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text to show when filter input is empty." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "loading", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the multiselect is in loading state." - }, - { - "name": "loadingIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-spinner pi-spin", - "description": "Icon to display in loading state." - }, - { - "name": "maxSelectedLabels", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Decides how many selected item labels to show at most." - }, { "name": "modelValue", "optional": true, @@ -16752,28 +16419,12 @@ "description": "Value of the component." }, { - "name": "optionDisabled", + "name": "options", "optional": true, "readonly": false, - "type": "string | Function", + "type": "any[]", "default": "", - "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." - }, - { - "name": "optionGroupChildren", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function that refers to the children options of option group." - }, - { - "name": "optionGroupLabel", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the label of an option group." + "description": "An array of selectitems to display as the available options." }, { "name": "optionLabel", @@ -16792,12 +16443,76 @@ "description": "Property name or getter function to use as the value of an option, defaults to the option itself when not defined." }, { - "name": "options", + "name": "optionDisabled", "optional": true, "readonly": false, - "type": "any[]", + "type": "string | Function", "default": "", - "description": "An array of selectitems to display as the available options." + "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." + }, + { + "name": "optionGroupLabel", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function to use as the label of an option group." + }, + { + "name": "optionGroupChildren", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function that refers to the children options of option group." + }, + { + "name": "scrollHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "200px", + "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." + }, + { + "name": "placeholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Label to display when there are no selections." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "panelStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the overlay panel." }, { "name": "panelClass", @@ -16816,52 +16531,84 @@ "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel." }, { - "name": "panelStyle", + "name": "filterInputProps", "optional": true, "readonly": false, - "type": "any", + "type": "InputHTMLAttributes", "default": "", - "description": "Inline style of the overlay panel." + "description": "Uses to pass all properties of the HTMLInputElement to the filter input inside the overlay panel." }, { - "name": "placeholder", + "name": "closeButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the clear button inside the overlay panel." + }, + { + "name": "dataKey", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Label to display when there are no selections." + "description": "A property to uniquely identify an option." }, { - "name": "removeTokenIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times-circle", - "description": "Icon to display in chip remove action." - }, - { - "name": "resetFilterOnHide", + "name": "filter", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Clears the filter value when hiding the dropdown." + "description": "When specified, displays a filter input at header." }, { - "name": "scrollHeight", + "name": "filterPlaceholder", "optional": true, "readonly": false, "type": "string", - "default": "200px", - "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." + "default": "", + "description": "Placeholder text to show when filter input is empty." }, { - "name": "selectAll", + "name": "filterLocale", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether all data is selected." + "type": "string", + "default": "", + "description": "Locale to use in filtering. The default locale is the host environment's current locale." + }, + { + "name": "filterMatchMode", + "optional": true, + "readonly": false, + "type": "string", + "default": "contains", + "description": "Defines the filtering algorithm to use when searching the options." + }, + { + "name": "filterFields", + "optional": true, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Fields used when filtering the options, defaults to optionLabel." + }, + { + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "string | HTMLElement", + "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." + }, + { + "name": "display", + "optional": true, + "readonly": false, + "type": "\"comma\" | \"chip\"", + "default": "comma", + "description": "Defines how the selected items are displayed." }, { "name": "selectedItemsLabel", @@ -16871,6 +16618,14 @@ "default": "'{0} items selected'", "description": "Label to display after exceeding max selected labels." }, + { + "name": "maxSelectedLabels", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Decides how many selected item labels to show at most." + }, { "name": "selectionLimit", "optional": true, @@ -16879,14 +16634,6 @@ "default": "", "description": "Maximum number of selectable items." }, - { - "name": "selectionMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "'{0} items selected'", - "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." - }, { "name": "showToggleAll", "optional": true, @@ -16896,12 +16643,76 @@ "description": "Whether to show the header checkbox to toggle the selection of all items at once." }, { - "name": "tabindex", + "name": "loading", "optional": true, "readonly": false, - "type": "string | number", - "default": "", - "description": "Index of the element in tabbing order." + "type": "boolean", + "default": "false", + "description": "Whether the multiselect is in loading state." + }, + { + "name": "checkboxIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-check", + "description": "Icon to display in the checkboxes." + }, + { + "name": "closeIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times", + "description": "Icon to display in the dropdown close button." + }, + { + "name": "dropdownIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." + }, + { + "name": "filterIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-search", + "description": "Icon to display in filter input." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." + }, + { + "name": "removeTokenIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times-circle", + "description": "Icon to display in chip remove action." + }, + { + "name": "selectAll", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether all data is selected." + }, + { + "name": "resetFilterOnHide", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Clears the filter value when hiding the dropdown." }, { "name": "virtualScrollerOptions", @@ -16910,6 +16721,86 @@ "type": "VirtualScrollerProps", "default": "", "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it." + }, + { + "name": "autoOptionFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." + }, + { + "name": "autoFilterFocus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to focus on the filter element when the overlay panel is shown." + }, + { + "name": "filterMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "'{0} results are available'", + "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "selectionMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "'{0} items selected'", + "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptySelectionMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No selected item", + "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptyFilterMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found", + "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "emptyMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found'", + "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string | number", + "default": "", + "description": "Index of the element in tabbing order." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." } ], "methods": [] @@ -16919,6 +16810,19 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "value", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t placeholder: string, // Placeholder prop value\n }", + "description": "value slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom value template." + }, { "name": "chip", "parameters": [ @@ -16932,6 +16836,76 @@ "returnType": "VNode[]", "description": "Custom chip template." }, + { + "name": "indicator", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." + }, + { + "name": "header", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t options: any, // Displayed options\n }", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: any, // Value of the component\n \t options: any, // Displayed options\n }", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template." + }, + { + "name": "option", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." + }, + { + "name": "optiongroup", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option group slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option group template." + }, + { + "name": "emptyfilter", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom emptyfilter template." + }, + { + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." + }, { "name": "content", "parameters": [ @@ -16945,50 +16919,6 @@ "returnType": "VNode[]", "description": "Custom content template." }, - { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template." - }, - { - "name": "emptyfilter", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom emptyfilter template." - }, - { - "name": "footer", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "footer slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", - "description": "header slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "indicator", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom indicator template." - }, { "name": "loader", "parameters": [ @@ -17001,45 +16931,115 @@ ], "returnType": "VNode[]", "description": "Custom loader template." - }, + } + ] + }, + "MultiSelectEmits": { + "description": "Defines valid emits in MultiSelect component.", + "relatedProp": "", + "props": [], + "methods": [ { - "name": "option", + "name": "update:modelValue", "parameters": [ { - "name": "scope", + "name": "value", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "option slot's params." + "type": "any", + "description": "New value." } ], - "returnType": "VNode[]", - "description": "Custom option template." + "returnType": "void", + "description": "Emitted when the value changes." }, { - "name": "optiongroup", + "name": "change", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "option group slot's params." + "type": "MultiSelectChangeEvent", + "description": "Custom change event." } ], - "returnType": "VNode[]", - "description": "Custom option group template." + "returnType": "void", + "description": "Callback to invoke on value change." }, { - "name": "value", + "name": "focus", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }", - "description": "value slot's params." + "type": "Event", + "description": "Browser event." } ], - "returnType": "VNode[]", - "description": "Custom value template." + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "before-show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is shown." + }, + { + "name": "before-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is hidden." + }, + { + "name": "filter", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "MultiSelectFilterEvent", + "description": "Custom filter event." + } + ], + "returnType": "void", + "description": "Callback to invoke on filter input." + }, + { + "name": "selectall-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "MultiSelectAllChangeEvent", + "description": "Custom select all change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when all data is selected." } ] } @@ -17063,212 +17063,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "OrderListEmits": { - "description": "Defines valid slots in OrderList component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "reorder", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "OrderListReorderEvent", - "description": "Custom reorder event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the list is reordered." - }, - { - "name": "selection-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "OrderListSelectionChangeEvent", - "description": "Custom selection change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when selection changes." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any[]", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - }, - { - "name": "update:selection", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any[]", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the selection changes." - } - ] - }, - "OrderListProps": { - "description": "Defines valid properties in OrderList component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive list element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying list element." - }, - { - "name": "breakpoint", - "optional": true, - "readonly": false, - "type": "string", - "default": "960px", - "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Name of the field that uniquely identifies the a record in the data." - }, - { - "name": "listProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLAttributes to the list element." - }, - { - "name": "listStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the the list element." - }, - { - "name": "metaKeySelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines whether metaKey is requred or not for the selection.\nWhen true metaKey needs to be pressed to select or unselect an item and\nwhen set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Value of the component." - }, - { - "name": "moveBottomButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move bottom button inside the component." - }, - { - "name": "moveDownButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move down button inside the component." - }, - { - "name": "moveTopButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move top button inside the component." - }, - { - "name": "moveUpButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move up button inside the component." - }, - { - "name": "responsive", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether the list optimizes layout based on screen size." - }, - { - "name": "selection", - "optional": true, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Selected items in the list." - }, - { - "name": "stripedRows", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether to displays rows with alternating colors." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "string | number", - "default": "", - "description": "Index of the element in tabbing order." - } - ], - "methods": [] - }, "OrderListReorderEvent": { "description": "Custom reorder event", "relatedProp": "OrderListEmits.reorder", "props": [ - { - "name": "direction", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Direction of the change; 'up', 'down', 'bottom', 'top'" - }, { "name": "originalEvent", "optional": false, @@ -17284,6 +17082,14 @@ "type": "any[]", "default": "", "description": "Ordered list" + }, + { + "name": "direction", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Direction of the change; 'up', 'down', 'bottom', 'top'" } ], "methods": [] @@ -17311,23 +17117,146 @@ ], "methods": [] }, + "OrderListProps": { + "description": "Defines valid properties in OrderList component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Value of the component." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the field that uniquely identifies the a record in the data." + }, + { + "name": "selection", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Selected items in the list." + }, + { + "name": "metaKeySelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines whether metaKey is requred or not for the selection.\nWhen true metaKey needs to be pressed to select or unselect an item and\nwhen set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically." + }, + { + "name": "listStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the the list element." + }, + { + "name": "responsive", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether the list optimizes layout based on screen size." + }, + { + "name": "breakpoint", + "optional": true, + "readonly": false, + "type": "string", + "default": "960px", + "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled." + }, + { + "name": "stripedRows", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether to displays rows with alternating colors." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string | number", + "default": "", + "description": "Index of the element in tabbing order." + }, + { + "name": "listProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLAttributes to the list element." + }, + { + "name": "moveUpButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move up button inside the component." + }, + { + "name": "moveTopButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move top button inside the component." + }, + { + "name": "moveDownButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move down button inside the component." + }, + { + "name": "moveBottomButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move bottom button inside the component." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive list element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying list element." + } + ], + "methods": [] + }, "OrderListSlots": { "description": "Defines valid slots in OrderList component.", "relatedProp": "", "props": [], "methods": [ - { - "name": "controlsend", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom controls end template." - }, - { - "name": "controlsstart", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom controls start template." - }, { "name": "header", "parameters": [], @@ -17340,12 +17269,83 @@ { "name": "scope", "optional": false, - "type": "{\n \t index: number, // Index of the item.\n \t item: any, // Item of the component\n }", + "type": "{\n \t item: any, // Item of the component\n \t index: number, // Index of the item.\n }", "description": "item slot's params." } ], "returnType": "VNode[]", "description": "Custom item template." + }, + { + "name": "controlsstart", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom controls start template." + }, + { + "name": "controlsend", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom controls end template." + } + ] + }, + "OrderListEmits": { + "description": "Defines valid slots in OrderList component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "update:selection", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the selection changes." + }, + { + "name": "reorder", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "OrderListReorderEvent", + "description": "Custom reorder event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the list is reordered." + }, + { + "name": "selection-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "OrderListSelectionChangeEvent", + "description": "Custom selection change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when selection changes." } ] } @@ -17369,7 +17369,76 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "OrganizationChartCollapsedKeys": { + "OrganizationChartNode": { + "description": "Defines valid properties in OrganizationChartNode.", + "relatedProp": "", + "props": [ + { + "name": "key", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Unique identifier of the node. (required)" + }, + { + "name": "type", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Type of the node to match a template." + }, + { + "name": "styleClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the node content." + }, + { + "name": "data", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Data represented by the node." + }, + { + "name": "selectable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether node is selectable when selection is enabled." + }, + { + "name": "collapsible", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether node is collapsible when node expansion is enabled." + }, + { + "name": "children", + "optional": true, + "readonly": false, + "type": "OrganizationChartNode[]", + "default": "", + "description": "Children nodes array." + }, + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "OrganizationChartSelectionKeys": { "relatedProp": "", "props": [ { @@ -17381,151 +17450,9 @@ ], "methods": [] }, - "OrganizationChartEmits": { - "description": "Defines valid emits in OrganizationChart component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "node-collapsed", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "OrganizationChartNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is collapsed." - }, - { - "name": "node-expand", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "OrganizationChartNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is expanded." - }, - { - "name": "node-select", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "OrganizationChartNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a suggestion is selected." - }, - { - "name": "node-unselect", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "OrganizationChartNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is unselected." - }, - { - "name": "update:collapsedKeys", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - }, - { - "name": "update:selectionKeys", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, - "OrganizationChartNode": { - "description": "Defines valid properties in OrganizationChartNode.", + "OrganizationChartCollapsedKeys": { "relatedProp": "", "props": [ - { - "name": "children", - "optional": true, - "readonly": false, - "type": "OrganizationChartNode[]", - "default": "", - "description": "Children nodes array." - }, - { - "name": "collapsible", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether node is collapsible when node expansion is enabled." - }, - { - "name": "data", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Data represented by the node." - }, - { - "name": "key", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Unique identifier of the node. (required)" - }, - { - "name": "selectable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether node is selectable when selection is enabled." - }, - { - "name": "styleClass", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class of the node content." - }, - { - "name": "type", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Type of the node to match a template." - }, { "name": "[key: string]", "optional": false, @@ -17540,20 +17467,12 @@ "relatedProp": "", "props": [ { - "name": "collapsedKeys", + "name": "value", "optional": true, "readonly": false, - "type": "OrganizationChartCollapsedKeys", + "type": "OrganizationChartNode", "default": "", - "description": "A map instance of key-value pairs to represented the collapsed nodes." - }, - { - "name": "collapsible", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the nodes can be expanded or toggled." + "description": "Value of the component." }, { "name": "selectionKeys", @@ -17572,24 +17491,20 @@ "description": "Type of the selection." }, { - "name": "value", + "name": "collapsedKeys", "optional": true, "readonly": false, - "type": "OrganizationChartNode", + "type": "OrganizationChartCollapsedKeys", "default": "", - "description": "Value of the component." - } - ], - "methods": [] - }, - "OrganizationChartSelectionKeys": { - "relatedProp": "", - "props": [ + "description": "A map instance of key-value pairs to represented the collapsed nodes." + }, { - "name": "[key: string]", - "optional": false, + "name": "collapsible", + "optional": true, "readonly": false, - "type": "any" + "type": "boolean", + "default": "false", + "description": "Whether the nodes can be expanded or toggled." } ], "methods": [] @@ -17619,6 +17534,91 @@ "description": "Custom content template." } ] + }, + "OrganizationChartEmits": { + "description": "Defines valid emits in OrganizationChart component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:selectionKeys", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "update:collapsedKeys", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "node-select", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "OrganizationChartNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a suggestion is selected." + }, + { + "name": "node-unselect", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "OrganizationChartNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is unselected." + }, + { + "name": "node-expand", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "OrganizationChartNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is expanded." + }, + { + "name": "node-collapsed", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "OrganizationChartNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is collapsed." + } + ] } } } @@ -17632,10 +17632,21 @@ "description": "Defines methods that can be accessed by the component's reference.", "values": [ { - "name": "hide", - "parameters": [], + "name": "toggle", + "parameters": [ + { + "name": "event", + "type": "Event", + "description": "Browser event." + }, + { + "name": "target", + "type": "any", + "description": "Optional target if event.currentTarget should not be used." + } + ], "returnType": "void", - "description": "Hides the overlay." + "description": "Toggles the visibility of the overlay." }, { "name": "show", @@ -17655,21 +17666,10 @@ "description": "Shows the overlay." }, { - "name": "toggle", - "parameters": [ - { - "name": "event", - "type": "Event", - "description": "Browser event." - }, - { - "name": "target", - "type": "any", - "description": "Optional target if event.currentTarget should not be used." - } - ], + "name": "hide", + "parameters": [], "returnType": "void", - "description": "Toggles the visibility of the overlay." + "description": "Hides the overlay." } ] } @@ -17694,61 +17694,10 @@ ], "methods": [] }, - "OverlayPanelEmits": { - "description": "Defines valid emits in OverlayPanel component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is hidden." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is shown." - } - ] - }, "OverlayPanelProps": { "description": "Defines valid properties in OverlayPanel component.", "relatedProp": "", "props": [ - { - "name": "appendTo", - "optional": true, - "readonly": false, - "type": "string | HTMLElement", - "default": "body", - "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." - }, - { - "name": "autoZIndex", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to automatically manage layering." - }, - { - "name": "baseZIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Base zIndex value to use in layering." - }, - { - "name": "breakpoints", - "optional": true, - "readonly": false, - "type": "OverlayPanelBreakpoints", - "default": "", - "description": "Object literal to define widths per screen size." - }, { "name": "dismissable", "optional": true, @@ -17764,6 +17713,38 @@ "type": "boolean", "default": "false", "description": "When enabled, displays a close icon at top right corner." + }, + { + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." + }, + { + "name": "baseZIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Base zIndex value to use in layering." + }, + { + "name": "autoZIndex", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to automatically manage layering." + }, + { + "name": "breakpoints", + "optional": true, + "readonly": false, + "type": "OverlayPanelBreakpoints", + "default": "", + "description": "Object literal to define widths per screen size." } ], "methods": [] @@ -17780,6 +17761,25 @@ "description": "Custom content template." } ] + }, + "OverlayPanelEmits": { + "description": "Defines valid emits in OverlayPanel component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is hidden." + } + ] } } } @@ -17813,6 +17813,14 @@ "default": "", "description": "Index of first record" }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, { "name": "page", "optional": false, @@ -17828,36 +17836,119 @@ "type": "number", "default": "", "description": "Total number of pages" - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" } ], "methods": [] }, + "PaginatorProps": { + "description": "Defines valid properties in Paginator component.", + "relatedProp": "", + "props": [ + { + "name": "totalRecords", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Number of total records." + }, + { + "name": "rows", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Data count to display per page." + }, + { + "name": "first", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Zero-relative number of the first row to be displayed." + }, + { + "name": "pageLinkSize", + "optional": true, + "readonly": false, + "type": "number", + "default": "5", + "description": "Number of page links to display." + }, + { + "name": "rowsPerPageOptions", + "optional": true, + "readonly": false, + "type": "number[]", + "default": "", + "description": "Array of integer values to display inside rows per page dropdown." + }, + { + "name": "template", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Template of the paginator, can either be a string or an object with key-value pairs to define templates per breakpoint.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" + }, + { + "name": "currentPageReportTemplate", + "optional": true, + "readonly": false, + "type": "string", + "default": "'({currentPage} of {totalPages})'", + "description": "Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" + }, + { + "name": "alwaysShow", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show the paginator even there is only one page." + } + ], + "methods": [] + }, + "PaginatorSlots": { + "description": "Defines valid slots in Paginator component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "start", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t state: PageState, // Current state\n }", + "description": "start slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom start template." + }, + { + "name": "end", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t state: PageState, // Current state\n }", + "description": "end slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom end template." + } + ] + }, "PaginatorEmits": { "description": "Defines valid emits in Paginator component.", "relatedProp": "", "props": [], "methods": [ - { - "name": "page", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "PageState", - "description": "New page state." - } - ], - "returnType": "void", - "description": "Callback to invoke when page changes, the event object contains information about the new state." - }, { "name": "update:first", "parameters": [ @@ -17883,110 +17974,19 @@ ], "returnType": "void", "description": "Emitted when the rows changes." - } - ] - }, - "PaginatorProps": { - "description": "Defines valid properties in Paginator component.", - "relatedProp": "", - "props": [ - { - "name": "alwaysShow", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show the paginator even there is only one page." }, { - "name": "currentPageReportTemplate", - "optional": true, - "readonly": false, - "type": "string", - "default": "'({currentPage} of {totalPages})'", - "description": "Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" - }, - { - "name": "first", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Zero-relative number of the first row to be displayed." - }, - { - "name": "pageLinkSize", - "optional": true, - "readonly": false, - "type": "number", - "default": "5", - "description": "Number of page links to display." - }, - { - "name": "rows", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Data count to display per page." - }, - { - "name": "rowsPerPageOptions", - "optional": true, - "readonly": false, - "type": "number[]", - "default": "", - "description": "Array of integer values to display inside rows per page dropdown." - }, - { - "name": "template", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Template of the paginator, can either be a string or an object with key-value pairs to define templates per breakpoint.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" - }, - { - "name": "totalRecords", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Number of total records." - } - ], - "methods": [] - }, - "PaginatorSlots": { - "description": "Defines valid slots in Paginator component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "end", + "name": "page", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t state: PageState, // Current state\n }", - "description": "end slot's params." + "type": "PageState", + "description": "New page state." } ], - "returnType": "VNode[]", - "description": "Custom end template." - }, - { - "name": "start", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t state: PageState, // Current state\n }", - "description": "start slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom start template." + "returnType": "void", + "description": "Callback to invoke when page changes, the event object contains information about the new state." } ] } @@ -18010,52 +18010,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "PanelEmits": { - "description": "Defines valid emits in Panel component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "toggle", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "PanelToggleEvent", - "description": "Custom toggle event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a tab toggle." - }, - { - "name": "update:collapsed", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the collapsed changes." - } - ] - }, - "PanelPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "PanelPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -18077,192 +18031,6 @@ ], "methods": [] }, - "PanelPassThroughOptions": { - "description": "Custom passthrough(pt) options.", - "relatedProp": "PanelProps.pt", - "props": [ - { - "name": "content", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the content's DOM element." - }, - { - "name": "footer", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the footer's DOM element." - }, - { - "name": "header", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the header's DOM element." - }, - { - "name": "headericon", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the headericon's DOM element." - }, - { - "name": "icons", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the title's DOM element." - }, - { - "name": "root", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the root's DOM element." - }, - { - "name": "title", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the title's DOM element." - }, - { - "name": "toggleablecontent", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the toggleablecontent's DOM element." - }, - { - "name": "toggler", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the toggler's DOM element." - } - ], - "methods": [] - }, - "PanelProps": { - "description": "Defines valid properties in Panel component.", - "relatedProp": "", - "props": [ - { - "name": "collapsed", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines the initial state of panel content." - }, - { - "name": "header", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Header text of the panel." - }, - { - "name": "pt", - "optional": true, - "readonly": false, - "type": "PanelPassThroughOptions", - "default": "", - "description": "Uses to pass attributes to DOM elements inside the component." - }, - { - "name": "toggleButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass the custom value to read for the button inside the component.", - "deprecated": "since v3.26.0. Use 'pt' property instead." - }, - { - "name": "toggleable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if content of panel can be expanded and collapsed." - } - ], - "methods": [] - }, - "PanelSlots": { - "description": "Defines valid slots in Panel slots.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "default", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom content template." - }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "headericon", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t collapsed: boolean, // Collapsed state as a boolean\n }", - "description": "header icon slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom header icon template of panel." - }, - { - "name": "icons", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom icons template." - } - ] - }, - "PanelState": { - "description": "Defines current inline state in Panel component.", - "relatedProp": "", - "props": [ - { - "name": "d_collapsed", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current collapsed state as a boolean." - } - ], - "methods": [] - }, "PanelToggleEvent": { "description": "Custom toggle event.", "relatedProp": "PanelEmits.toggle", @@ -18285,6 +18053,238 @@ } ], "methods": [] + }, + "PanelPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "PanelProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "header", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the header's DOM element." + }, + { + "name": "title", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the title's DOM element." + }, + { + "name": "icons", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the title's DOM element." + }, + { + "name": "toggler", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the toggler's DOM element." + }, + { + "name": "headericon", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the headericon's DOM element." + }, + { + "name": "toggleablecontent", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the toggleablecontent's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + }, + { + "name": "footer", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the footer's DOM element." + } + ], + "methods": [] + }, + "PanelPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "PanelState": { + "description": "Defines current inline state in Panel component.", + "relatedProp": "", + "props": [ + { + "name": "d_collapsed", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current collapsed state as a boolean." + } + ], + "methods": [] + }, + "PanelProps": { + "description": "Defines valid properties in Panel component.", + "relatedProp": "", + "props": [ + { + "name": "header", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Header text of the panel." + }, + { + "name": "toggleable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if content of panel can be expanded and collapsed." + }, + { + "name": "collapsed", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines the initial state of panel content." + }, + { + "name": "toggleButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass the custom value to read for the button inside the component.", + "deprecated": "since v3.26.0. Use 'pt' property instead." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "PanelPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." + } + ], + "methods": [] + }, + "PanelSlots": { + "description": "Defines valid slots in Panel slots.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "default", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." + }, + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "icons", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom icons template." + }, + { + "name": "headericon", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t collapsed: boolean, // Collapsed state as a boolean\n }", + "description": "header icon slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header icon template of panel." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + } + ] + }, + "PanelEmits": { + "description": "Defines valid emits in Panel component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:collapsed", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the collapsed changes." + }, + { + "name": "toggle", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "PanelToggleEvent", + "description": "Custom toggle event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a tab toggle." + } + ] } } }, @@ -18314,52 +18314,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "PanelMenuEmits": { - "description": "Defines valid emits in PanelMenu component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "panel-close", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "PanelMenuPanelCloseEvent", - "description": "Custom panel close event." - } - ], - "returnType": "void", - "description": "Callback to invoke when an active panel is collapsed by clicking on the header." - }, - { - "name": "panel-open", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "PanelMenuPanelOpenEvent", - "description": "Custom panel open event." - } - ], - "returnType": "void", - "description": "Callback to invoke when a panel gets expanded." - }, - { - "name": "update:expandedKeys", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the expandedKeys changes." - } - ] - }, "PanelMenuExpandedKeys": { "description": "Custom expanded keys metadata.", "relatedProp": "PanelMenuProps.expandedKeys", @@ -18373,34 +18327,18 @@ ], "methods": [] }, - "PanelMenuPanelCloseEvent": { - "description": "Custom panel close event.", - "relatedProp": "PanelMenuEmits['panel-close']", - "props": [ - { - "name": "item", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Current item." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "MouseEvent", - "default": "", - "description": "Browser mouse event." - } - ], - "methods": [], - "extendedTypes": "PanelMenuPanelOpenEvent" - }, "PanelMenuPanelOpenEvent": { "description": "Custom panel open event.", "relatedProp": "PanelMenuEmits['panel-open']", "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "MouseEvent", + "default": "", + "description": "Browser mouse event." + }, { "name": "item", "optional": false, @@ -18408,7 +18346,15 @@ "type": "any", "default": "", "description": "Current item." - }, + } + ], + "methods": [], + "extendedBy": "PanelMenuPanelCloseEvent" + }, + "PanelMenuPanelCloseEvent": { + "description": "Custom panel close event.", + "relatedProp": "PanelMenuEmits['panel-close']", + "props": [ { "name": "originalEvent", "optional": false, @@ -18416,22 +18362,30 @@ "type": "MouseEvent", "default": "", "description": "Browser mouse event." + }, + { + "name": "item", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Current item." } ], "methods": [], - "extendedBy": "PanelMenuPanelCloseEvent" + "extendedTypes": "PanelMenuPanelOpenEvent" }, "PanelMenuProps": { "description": "Defines valid properties in PanelMenu component.", "relatedProp": "", "props": [ { - "name": "exact", + "name": "model", "optional": true, "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." + "type": "MenuItem[]", + "default": "", + "description": "An array of menuitems." }, { "name": "expandedKeys", @@ -18442,12 +18396,12 @@ "description": "A map of keys to represent the expansion state in controlled mode." }, { - "name": "model", + "name": "exact", "optional": true, "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "An array of menuitems." + "type": "boolean", + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "tabindex", @@ -18479,6 +18433,52 @@ "description": "Custom content for each item." } ] + }, + "PanelMenuEmits": { + "description": "Defines valid emits in PanelMenu component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:expandedKeys", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the expandedKeys changes." + }, + { + "name": "panel-open", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "PanelMenuPanelOpenEvent", + "description": "Custom panel open event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a panel gets expanded." + }, + { + "name": "panel-close", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "PanelMenuPanelCloseEvent", + "description": "Custom panel close event." + } + ], + "returnType": "void", + "description": "Callback to invoke when an active panel is collapsed by clicking on the header." + } + ] } } } @@ -18500,6 +18500,239 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "PasswordProps": { + "description": "Defines valid properties in Password component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "Nullable", + "default": "", + "description": "Value of the component." + }, + { + "name": "promptLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text to prompt password entry. Defaults to PrimeVue Locale configuration." + }, + { + "name": "mediumRegex", + "optional": true, + "readonly": false, + "type": "string", + "default": "^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})", + "description": "Regex for a medium level password." + }, + { + "name": "strongRegex", + "optional": true, + "readonly": false, + "type": "string", + "default": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})", + "description": "Regex for a strong level password." + }, + { + "name": "weakLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text for a weak password. Defaults to PrimeVue Locale configuration." + }, + { + "name": "mediumLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text for a medium password. Defaults to PrimeVue Locale configuration." + }, + { + "name": "strongLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text for a strong password. Defaults to PrimeVue Locale configuration." + }, + { + "name": "feedback", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show the strength indicator or not." + }, + { + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." + }, + { + "name": "toggleMask", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to show an icon to display the password as plain text." + }, + { + "name": "hideIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-eye-slash", + "description": "Icon to hide displaying the password as plain text." + }, + { + "name": "showIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-eye", + "description": "Icon to show displaying the password as plain text." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "placeholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Placeholder text for the input." + }, + { + "name": "required", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that an input field must be filled out before submitting the form." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "panelId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying overlay panel element." + }, + { + "name": "panelClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the overlay panel." + }, + { + "name": "panelStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the overlay panel." + }, + { + "name": "panelProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." + } + ], + "methods": [], + "extendedTypes": "InputHTMLAttributes" + }, + "PasswordSlots": { + "description": "Defines valid slots in Password component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + }, + { + "name": "content", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." + } + ] + }, "PasswordEmits": { "description": "Defines valid emits in Password component.", "relatedProp": "", @@ -18519,239 +18752,6 @@ "description": "Emitted when the value changes." } ] - }, - "PasswordProps": { - "description": "Defines valid properties in Password component.", - "relatedProp": "", - "props": [ - { - "name": "appendTo", - "optional": true, - "readonly": false, - "type": "string | HTMLElement", - "default": "body", - "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "feedback", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show the strength indicator or not." - }, - { - "name": "hideIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-eye-slash", - "description": "Icon to hide displaying the password as plain text." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "mediumLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Text for a medium password. Defaults to PrimeVue Locale configuration." - }, - { - "name": "mediumRegex", - "optional": true, - "readonly": false, - "type": "string", - "default": "^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})", - "description": "Regex for a medium level password." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "Nullable", - "default": "", - "description": "Value of the component." - }, - { - "name": "panelClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the overlay panel." - }, - { - "name": "panelId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying overlay panel element." - }, - { - "name": "panelProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." - }, - { - "name": "panelStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the overlay panel." - }, - { - "name": "placeholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text for the input." - }, - { - "name": "promptLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Text to prompt password entry. Defaults to PrimeVue Locale configuration." - }, - { - "name": "required", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that an input field must be filled out before submitting the form." - }, - { - "name": "showIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-eye", - "description": "Icon to show displaying the password as plain text." - }, - { - "name": "strongLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Text for a strong password. Defaults to PrimeVue Locale configuration." - }, - { - "name": "strongRegex", - "optional": true, - "readonly": false, - "type": "string", - "default": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})", - "description": "Regex for a strong level password." - }, - { - "name": "toggleMask", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to show an icon to display the password as plain text." - }, - { - "name": "weakLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Text for a weak password. Defaults to PrimeVue Locale configuration." - } - ], - "methods": [], - "extendedTypes": "InputHTMLAttributes" - }, - "PasswordSlots": { - "description": "Defines valid slots in Password component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "content", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom content template." - }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - } - ] } } } @@ -18773,62 +18773,443 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "PickListReorderEvent": { + "description": "Custom reorder event.", + "relatedProp": "PickListEmits.reorder", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Ordered list" + }, + { + "name": "direction", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Direction of the change; 'up', 'down', 'bottom', 'top'" + }, + { + "name": "listIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the list that is ordered, 0 represents the source and 1 represents the target list." + } + ], + "methods": [] + }, + "PickListSelectionChangeEvent": { + "description": "Custom selection change event.", + "relatedProp": "PickListEmits['selection-change']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Selected item" + } + ], + "methods": [] + }, + "PickListMoveToTargetEvent": { + "description": "Custom move-to-target event.", + "relatedProp": "PickListEmits['move-to-target']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "items", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Moved items" + } + ], + "methods": [], + "extendedBy": "PickListMoveAllToTargetEvent,PickListMoveToSourceEvent,PickListMoveAllToSourceEvent" + }, + "PickListMoveAllToTargetEvent": { + "description": "Custom move-all-to-target event.", + "relatedProp": "PickListEmits['move-all-to-target']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "items", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Moved items" + } + ], + "methods": [], + "extendedTypes": "PickListMoveToTargetEvent" + }, + "PickListMoveToSourceEvent": { + "description": "Custom move-to-source event.", + "relatedProp": "PickListEmits['move-all-to-target']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "items", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Moved items" + } + ], + "methods": [], + "extendedTypes": "PickListMoveToTargetEvent" + }, + "PickListMoveAllToSourceEvent": { + "description": "Custom move-all-to-source event.", + "relatedProp": "PickListEmits['move-all-to-target']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "items", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Moved items" + } + ], + "methods": [], + "extendedTypes": "PickListMoveToTargetEvent" + }, + "PickListProps": { + "description": "Defines valid properties in PickList component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "any[][]", + "default": "", + "description": "Value of the component as a multidimensional array." + }, + { + "name": "selection", + "optional": true, + "readonly": false, + "type": "any[][]", + "default": "", + "description": "Selected items in the list as a multidimensional array." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the field that uniquely identifies the a record in the data." + }, + { + "name": "metaKeySelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines whether metaKey is requred or not for the selection.\nWhen true metaKey needs to be pressed to select or unselect an item and\nwhen set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically." + }, + { + "name": "listStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the the list element." + }, + { + "name": "responsive", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether the list optimizes layout based on screen size." + }, + { + "name": "breakpoint", + "optional": true, + "readonly": false, + "type": "string", + "default": "960px", + "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled." + }, + { + "name": "stripedRows", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to displays rows with alternating colors." + }, + { + "name": "showSourceControls", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to show buttons of source list." + }, + { + "name": "showTargetControls", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to show buttons of target list." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string | number", + "default": "", + "description": "Index of the list element in tabbing order." + }, + { + "name": "targetListProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLAttributes to the target list element." + }, + { + "name": "sourceListProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLAttributes to the source list element." + }, + { + "name": "moveUpButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move up button inside the component." + }, + { + "name": "moveTopButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move top button inside the component." + }, + { + "name": "moveDownButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move down button inside the component." + }, + { + "name": "moveBottomButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move bottom button inside the component." + }, + { + "name": "moveToTargetProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move to target button inside the component." + }, + { + "name": "moveAllToTargetProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move all to target button inside the component." + }, + { + "name": "moveToSourceProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move to source button inside the component." + }, + { + "name": "moveAllToSourceProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the move all to source button inside the component." + } + ], + "methods": [] + }, + "PickListSlots": { + "description": "Defines valid slots in PickList component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "item", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: any, // Item of the component\n \t index: number, // Index of the item\n }", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." + }, + { + "name": "sourceheader", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom source header template." + }, + { + "name": "targetheader", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom target header template." + }, + { + "name": "sourcecontrolsstart", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom source controls start template." + }, + { + "name": "sourcecontrolsend", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom source controls end template." + }, + { + "name": "movecontrolsstart", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom move controls start template." + }, + { + "name": "movecontrolsend", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom move controls end template." + }, + { + "name": "targetcontrolsstart", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom target controls start template." + }, + { + "name": "targetcontrolsend", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom target controls end template." + } + ] + }, "PickListEmits": { "description": "Defines valid emits in PickList component.", "relatedProp": "", "props": [], "methods": [ { - "name": "move-all-to-source", + "name": "update:modelValue", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "PickListMoveAllToSourceEvent", - "description": "Custom move all to source event." + "type": "any[][]", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when all items are moved to the source list." + "description": "Emitted when the value changes." }, { - "name": "move-all-to-target", + "name": "update:selection", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "PickListMoveAllToTargetEvent", - "description": "Custom move all to target event." + "type": "any[][]", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when all items are moved to the target list." - }, - { - "name": "move-to-source", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "PickListMoveToSourceEvent", - "description": "Custom move to source event." - } - ], - "returnType": "void", - "description": "Callback to invoke when one or more items are moved to the source list." - }, - { - "name": "move-to-target", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "PickListMoveToTargetEvent", - "description": "Custom move to target event." - } - ], - "returnType": "void", - "description": "Callback to invoke when one or more items are moved to the target list." + "description": "Emitted when the selection changes." }, { "name": "reorder", @@ -18857,437 +19238,56 @@ "description": "Callback to invoke when one or more items are moved to the other list." }, { - "name": "update:modelValue", + "name": "move-to-target", "parameters": [ { - "name": "value", + "name": "event", "optional": false, - "type": "any[][]", - "description": "New value." + "type": "PickListMoveToTargetEvent", + "description": "Custom move to target event." } ], "returnType": "void", - "description": "Emitted when the value changes." + "description": "Callback to invoke when one or more items are moved to the target list." }, { - "name": "update:selection", + "name": "move-all-to-target", "parameters": [ { - "name": "value", + "name": "event", "optional": false, - "type": "any[][]", - "description": "New value." + "type": "PickListMoveAllToTargetEvent", + "description": "Custom move all to target event." } ], "returnType": "void", - "description": "Emitted when the selection changes." - } - ] - }, - "PickListMoveAllToSourceEvent": { - "description": "Custom move-all-to-source event.", - "relatedProp": "PickListEmits['move-all-to-target']", - "props": [ - { - "name": "items", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Moved items" + "description": "Callback to invoke when all items are moved to the target list." }, { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedTypes": "PickListMoveToTargetEvent" - }, - "PickListMoveAllToTargetEvent": { - "description": "Custom move-all-to-target event.", - "relatedProp": "PickListEmits['move-all-to-target']", - "props": [ - { - "name": "items", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Moved items" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedTypes": "PickListMoveToTargetEvent" - }, - "PickListMoveToSourceEvent": { - "description": "Custom move-to-source event.", - "relatedProp": "PickListEmits['move-all-to-target']", - "props": [ - { - "name": "items", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Moved items" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedTypes": "PickListMoveToTargetEvent" - }, - "PickListMoveToTargetEvent": { - "description": "Custom move-to-target event.", - "relatedProp": "PickListEmits['move-to-target']", - "props": [ - { - "name": "items", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Moved items" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - } - ], - "methods": [], - "extendedBy": "PickListMoveAllToTargetEvent,PickListMoveToSourceEvent,PickListMoveAllToSourceEvent" - }, - "PickListProps": { - "description": "Defines valid properties in PickList component.", - "relatedProp": "", - "props": [ - { - "name": "breakpoint", - "optional": true, - "readonly": false, - "type": "string", - "default": "960px", - "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Name of the field that uniquely identifies the a record in the data." - }, - { - "name": "listStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the the list element." - }, - { - "name": "metaKeySelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines whether metaKey is requred or not for the selection.\nWhen true metaKey needs to be pressed to select or unselect an item and\nwhen set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "any[][]", - "default": "", - "description": "Value of the component as a multidimensional array." - }, - { - "name": "moveAllToSourceProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move all to source button inside the component." - }, - { - "name": "moveAllToTargetProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move all to target button inside the component." - }, - { - "name": "moveBottomButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move bottom button inside the component." - }, - { - "name": "moveDownButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move down button inside the component." - }, - { - "name": "moveToSourceProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move to source button inside the component." - }, - { - "name": "moveToTargetProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move to target button inside the component." - }, - { - "name": "moveTopButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move top button inside the component." - }, - { - "name": "moveUpButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the move up button inside the component." - }, - { - "name": "responsive", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether the list optimizes layout based on screen size." - }, - { - "name": "selection", - "optional": true, - "readonly": false, - "type": "any[][]", - "default": "", - "description": "Selected items in the list as a multidimensional array." - }, - { - "name": "showSourceControls", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to show buttons of source list." - }, - { - "name": "showTargetControls", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to show buttons of target list." - }, - { - "name": "sourceListProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLAttributes to the source list element." - }, - { - "name": "stripedRows", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to displays rows with alternating colors." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "string | number", - "default": "", - "description": "Index of the list element in tabbing order." - }, - { - "name": "targetListProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLAttributes to the target list element." - } - ], - "methods": [] - }, - "PickListReorderEvent": { - "description": "Custom reorder event.", - "relatedProp": "PickListEmits.reorder", - "props": [ - { - "name": "direction", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Direction of the change; 'up', 'down', 'bottom', 'top'" - }, - { - "name": "listIndex", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the list that is ordered, 0 represents the source and 1 represents the target list." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Ordered list" - } - ], - "methods": [] - }, - "PickListSelectionChangeEvent": { - "description": "Custom selection change event.", - "relatedProp": "PickListEmits['selection-change']", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any[]", - "default": "", - "description": "Selected item" - } - ], - "methods": [] - }, - "PickListSlots": { - "description": "Defines valid slots in PickList component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "item", + "name": "move-to-source", "parameters": [ { - "name": "scope", + "name": "event", "optional": false, - "type": "{\n \t index: number, // Index of the item\n \t item: any, // Item of the component\n }", - "description": "item slot's params." + "type": "PickListMoveToSourceEvent", + "description": "Custom move to source event." } ], - "returnType": "VNode[]", - "description": "Custom item template." + "returnType": "void", + "description": "Callback to invoke when one or more items are moved to the source list." }, { - "name": "movecontrolsend", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom move controls end template." - }, - { - "name": "movecontrolsstart", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom move controls start template." - }, - { - "name": "sourcecontrolsend", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom source controls end template." - }, - { - "name": "sourcecontrolsstart", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom source controls start template." - }, - { - "name": "sourceheader", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom source header template." - }, - { - "name": "targetcontrolsend", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom target controls end template." - }, - { - "name": "targetcontrolsstart", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom target controls start template." - }, - { - "name": "targetheader", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom target header template." + "name": "move-all-to-source", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "PickListMoveAllToSourceEvent", + "description": "Custom move all to source event." + } + ], + "returnType": "void", + "description": "Callback to invoke when all items are moved to the source list." } ] } @@ -19364,16 +19364,18 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ProgressBarEmits": { - "description": "Defines valid emits in ProgressBar component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "ProgressBarProps": { "description": "Defines valid properties in ProgressBar component.", "relatedProp": "", "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Current value of the progress." + }, { "name": "mode", "optional": true, @@ -19389,14 +19391,6 @@ "type": "boolean", "default": "true", "description": "Whether to display the progress bar value." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Current value of the progress." } ], "methods": [] @@ -19413,6 +19407,12 @@ "description": "Custom content slot." } ] + }, + "ProgressBarEmits": { + "description": "Defines valid emits in ProgressBar component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -19434,23 +19434,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ProgressSpinnerEmits": { - "description": "Defines valid emits in ProgressSpinner component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "ProgressSpinnerProps": { "description": "Defines valid properties in ProgressSpinner component.", "relatedProp": "", "props": [ { - "name": "animationDuration", + "name": "strokeWidth", "optional": true, "readonly": false, "type": "string", - "default": "2s", - "description": "Duration of the rotate animation." + "default": "2", + "description": "Width of the circle stroke." }, { "name": "fill", @@ -19461,12 +19455,12 @@ "description": "Color for the background of the circle." }, { - "name": "strokeWidth", + "name": "animationDuration", "optional": true, "readonly": false, "type": "string", - "default": "2", - "description": "Width of the circle stroke." + "default": "2s", + "description": "Duration of the rotate animation." } ], "methods": [] @@ -19476,6 +19470,12 @@ "relatedProp": "", "props": [], "methods": [] + }, + "ProgressSpinnerEmits": { + "description": "Defines valid emits in ProgressSpinner component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -19497,111 +19497,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "RadioButtonEmits": { - "description": "Defines valid emits in RadioButton component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke on radio button value change." - }, - { - "name": "click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke on radio button click." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "any", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "RadioButtonProps": { "description": "Defines valid properties in RadioButton component.", "relatedProp": "", "props": [ { - "name": "aria-label", + "name": "value", "optional": true, "readonly": false, - "type": "string", + "type": "any", "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." + "description": "Value of the checkbox." }, { "name": "modelValue", @@ -19620,12 +19526,60 @@ "description": "Name of the input element." }, { - "name": "value", + "name": "disabled", "optional": true, "readonly": false, - "type": "any", + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", "default": "", - "description": "Value of the checkbox." + "description": "Identifier of the underlying input element." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." } ], "methods": [] @@ -19634,6 +19588,52 @@ "relatedProp": "", "props": [], "methods": [] + }, + "RadioButtonEmits": { + "description": "Defines valid emits in RadioButton component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on radio button click." + }, + { + "name": "change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on radio button value change." + } + ] } } } @@ -19678,23 +19678,141 @@ ], "methods": [] }, + "RatingProps": { + "description": "Defines valid properties in Rating component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Value of the rating." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the element." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the element should be disabled." + }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that component is read-only." + }, + { + "name": "stars", + "optional": true, + "readonly": false, + "type": "number", + "default": "5", + "description": "Number of stars." + }, + { + "name": "cancel", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "When specified a cancel icon is displayed to allow clearing the value." + }, + { + "name": "onIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-star", + "description": "Icon for the on state." + }, + { + "name": "offIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-star-fill", + "description": "Icon for the off state." + }, + { + "name": "cancelIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-ban", + "description": "Icon for the cancelable state." + } + ], + "methods": [] + }, + "RatingSlots": { + "description": "Defines valid slots in Rating component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "cancelicon", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom cancel icon template." + }, + { + "name": "onicon", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: number, // Item value\n }", + "description": "on icon slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom on icon template." + }, + { + "name": "officon", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t value: number, // Item value\n }", + "description": "off icon slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom off icon template." + } + ] + }, "RatingEmits": { "description": "Defines valid emits in Rating component.", "relatedProp": "", "props": [], "methods": [ { - "name": "blur", + "name": "update:modelValue", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "Event", - "description": "Browser event." + "type": "number", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when the component loses focus." + "description": "Emitted when the value changes." }, { "name": "change", @@ -19723,135 +19841,17 @@ "description": "Callback to invoke when the component receives focus." }, { - "name": "update:modelValue", + "name": "blur", "parameters": [ { - "name": "value", + "name": "event", "optional": false, - "type": "number", - "description": "New value." + "type": "Event", + "description": "Browser event." } ], "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, - "RatingProps": { - "description": "Defines valid properties in Rating component.", - "relatedProp": "", - "props": [ - { - "name": "cancel", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "When specified a cancel icon is displayed to allow clearing the value." - }, - { - "name": "cancelIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-ban", - "description": "Icon for the cancelable state." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the element should be disabled." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Value of the rating." - }, - { - "name": "name", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Name of the element." - }, - { - "name": "offIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-star-fill", - "description": "Icon for the off state." - }, - { - "name": "onIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-star", - "description": "Icon for the on state." - }, - { - "name": "readonly", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that component is read-only." - }, - { - "name": "stars", - "optional": true, - "readonly": false, - "type": "number", - "default": "5", - "description": "Number of stars." - } - ], - "methods": [] - }, - "RatingSlots": { - "description": "Defines valid slots in Rating component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "cancelicon", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom cancel icon template." - }, - { - "name": "officon", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t value: number, // Item value\n }", - "description": "off icon slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom off icon template." - }, - { - "name": "onicon", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t value: number, // Item value\n }", - "description": "on icon slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom on icon template." + "description": "Callback to invoke when the component loses focus." } ] } @@ -19893,12 +19893,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "RowEmits": { - "description": "Defines valid emits in Row component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "RowProps": { "description": "Defines valid properties in Row component.", "relatedProp": "", @@ -19910,6 +19904,12 @@ "relatedProp": "", "props": [], "methods": [] + }, + "RowEmits": { + "description": "Defines valid emits in Row component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -19931,24 +19931,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ScrollPanelEmits": { - "relatedProp": "", - "props": [], - "methods": [] - }, - "ScrollPanelPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "ScrollPanelPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -19974,30 +19956,6 @@ "description": "Custom passthrough(pt) options.", "relatedProp": "ScrollPanelProps.pt", "props": [ - { - "name": "barx", - "optional": true, - "readonly": false, - "type": "ScrollPanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the horizontal panel's DOM element." - }, - { - "name": "bary", - "optional": true, - "readonly": false, - "type": "ScrollPanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the vertical panel's DOM element." - }, - { - "name": "content", - "optional": true, - "readonly": false, - "type": "ScrollPanelPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the content's DOM element." - }, { "name": "root", "optional": true, @@ -20013,6 +19971,82 @@ "type": "ScrollPanelPassThroughOptionType", "default": "", "description": "Uses to pass attributes to the wrapper's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "ScrollPanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + }, + { + "name": "barx", + "optional": true, + "readonly": false, + "type": "ScrollPanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the horizontal panel's DOM element." + }, + { + "name": "bary", + "optional": true, + "readonly": false, + "type": "ScrollPanelPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the vertical panel's DOM element." + } + ], + "methods": [] + }, + "ScrollPanelPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "ScrollPanelState": { + "description": "Defines current inline state in Panel component.", + "relatedProp": "", + "props": [ + { + "name": "id", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current id state as a string." + }, + { + "name": "orientation", + "optional": false, + "readonly": false, + "type": "string", + "default": "vertical", + "description": "Current scrollpanel orientation." + }, + { + "name": "lastScrollTop", + "optional": false, + "readonly": false, + "type": "number", + "default": "0", + "description": "Latest scroll top position." + }, + { + "name": "lastScrollLeft", + "optional": false, + "readonly": false, + "type": "number", + "default": "0", + "description": "Latest scroll left position." } ], "methods": [] @@ -20021,14 +20055,6 @@ "description": "Defines valid properties in ScrollPanel component.", "relatedProp": "", "props": [ - { - "name": "pt", - "optional": true, - "readonly": false, - "type": "ScrollPanelPassThroughOptions", - "default": "", - "description": "Uses to pass attributes to DOM elements inside the component." - }, { "name": "step", "optional": true, @@ -20036,6 +20062,14 @@ "type": "number", "default": "5", "description": "Step factor to scroll the content while pressing the arrow keys." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ScrollPanelPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -20054,43 +20088,9 @@ ], "methods": [] }, - "ScrollPanelState": { - "description": "Defines current inline state in Panel component.", + "ScrollPanelEmits": { "relatedProp": "", - "props": [ - { - "name": "id", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Current id state as a string." - }, - { - "name": "lastScrollLeft", - "optional": false, - "readonly": false, - "type": "number", - "default": "0", - "description": "Latest scroll left position." - }, - { - "name": "lastScrollTop", - "optional": false, - "readonly": false, - "type": "number", - "default": "0", - "description": "Latest scroll top position." - }, - { - "name": "orientation", - "optional": false, - "readonly": false, - "type": "string", - "default": "vertical", - "description": "Current scrollpanel orientation." - } - ], + "props": [], "methods": [] } } @@ -20121,32 +20121,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ScrollTopEmits": { - "description": "Defines valid emits in ScrollTop component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "ScrollTopProps": { "description": "Defines valid properties in ScrollTop component.", "relatedProp": "", "props": [ - { - "name": "behavior", - "optional": true, - "readonly": false, - "type": "string", - "default": "smooth", - "description": "Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump." - }, - { - "name": "icon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-chevron-up", - "description": "Icon to display." - }, { "name": "target", "optional": true, @@ -20162,6 +20140,22 @@ "type": "number", "default": "400", "description": "Defines the threshold value of the vertical scroll position of the target to toggle the visibility." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-chevron-up", + "description": "Icon to display." + }, + { + "name": "behavior", + "optional": true, + "readonly": false, + "type": "string", + "default": "smooth", + "description": "Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump." } ], "methods": [] @@ -20171,6 +20165,12 @@ "relatedProp": "", "props": [], "methods": [] + }, + "ScrollTopEmits": { + "description": "Defines valid emits in ScrollTop component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -20215,23 +20215,130 @@ ], "methods": [] }, + "SelectButtonProps": { + "description": "Defines valid properties in SelectButton component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Value of the component." + }, + { + "name": "options", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "An array of selectitems to display as the available options." + }, + { + "name": "optionLabel", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function to use as the label of an option." + }, + { + "name": "optionValue", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function to use as the value of an option, defaults to the option itself when not defined." + }, + { + "name": "optionDisabled", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." + }, + { + "name": "multiple", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, allows selecting multiple values." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the element should be disabled." + }, + { + "name": "dataKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "A property to uniquely identify an option." + }, + { + "name": "unselectable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether selection can be cleared." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying element." + } + ], + "methods": [] + }, + "SelectButtonSlots": { + "description": "Defines valid slots in SelectButton component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "option", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each option." + } + ] + }, "SelectButtonEmits": { "description": "Defines valid emits in SelectButton component.", "relatedProp": "", "props": [], "methods": [ { - "name": "blur", + "name": "update:modelValue", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "Event", - "description": "Browser event." + "type": "any", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke on blur." + "description": "Emitted when the value changes." }, { "name": "change", @@ -20259,124 +20366,17 @@ "description": "Callback to invoke on focus." }, { - "name": "update:modelValue", + "name": "blur", "parameters": [ { - "name": "value", + "name": "event", "optional": false, - "type": "any", - "description": "New value." + "type": "Event", + "description": "Browser event." } ], "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, - "SelectButtonProps": { - "description": "Defines valid properties in SelectButton component.", - "relatedProp": "", - "props": [ - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying element." - }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "A property to uniquely identify an option." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the element should be disabled." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Value of the component." - }, - { - "name": "multiple", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, allows selecting multiple values." - }, - { - "name": "optionDisabled", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." - }, - { - "name": "optionLabel", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the label of an option." - }, - { - "name": "optionValue", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or getter function to use as the value of an option, defaults to the option itself when not defined." - }, - { - "name": "options", - "optional": true, - "readonly": false, - "type": "any[]", - "default": "", - "description": "An array of selectitems to display as the available options." - }, - { - "name": "unselectable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether selection can be cleared." - } - ], - "methods": [] - }, - "SelectButtonSlots": { - "description": "Defines valid slots in SelectButton component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "option", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", - "description": "option slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom content for each option." + "description": "Callback to invoke on blur." } ] } @@ -20400,89 +20400,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "SidebarEmits": { - "description": "Defines valid emits in Sidebar component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when sidebar gets hidden." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when sidebar gets shown." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "boolean", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, "SidebarProps": { "description": "Defines valid properties in Sidebar component.", "relatedProp": "", "props": [ { - "name": "autoZIndex", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to automatically manage layering." - }, - { - "name": "baseZIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Base zIndex value to use in layering." - }, - { - "name": "blockScroll", + "name": "visible", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Whether background scroll should be blocked when sidebar is visible." - }, - { - "name": "closeIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times", - "description": "Icon to display in the sidebar close button." - }, - { - "name": "dismissable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether clicking outside closes the panel." - }, - { - "name": "modal", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to a modal layer behind the sidebar." + "description": "Specifies the visibility of the dialog." }, { "name": "position", @@ -20492,6 +20420,30 @@ "default": "left", "description": "Specifies the position of the sidebar." }, + { + "name": "baseZIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Base zIndex value to use in layering." + }, + { + "name": "autoZIndex", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to automatically manage layering." + }, + { + "name": "dismissable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether clicking outside closes the panel." + }, { "name": "showCloseIcon", "optional": true, @@ -20501,12 +20453,28 @@ "description": "Whether to display a close icon inside the panel." }, { - "name": "visible", + "name": "closeIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times", + "description": "Icon to display in the sidebar close button." + }, + { + "name": "modal", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to a modal layer behind the sidebar." + }, + { + "name": "blockScroll", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Specifies the visibility of the dialog." + "description": "Whether background scroll should be blocked when sidebar is visible." } ], "methods": [] @@ -20529,6 +20497,38 @@ "description": "Custom header template." } ] + }, + "SidebarEmits": { + "description": "Defines valid emits in Sidebar component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when sidebar gets shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when sidebar gets hidden." + } + ] } } } @@ -20550,40 +20550,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "SkeletonEmits": { - "description": "Defines valid emits in Skeleton component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "SkeletonProps": { "description": "Defines valid properties in Skeleton component.", "relatedProp": "", "props": [ - { - "name": "animation", - "optional": true, - "readonly": false, - "type": "\"none\" | \"wave\"", - "default": "wave", - "description": "Type of the animation." - }, - { - "name": "borderRadius", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Border radius of the element, defaults to value from theme." - }, - { - "name": "height", - "optional": true, - "readonly": false, - "type": "string", - "default": "1rem", - "description": "Height of the element." - }, { "name": "shape", "optional": true, @@ -20607,6 +20577,30 @@ "type": "string", "default": "100%", "description": "Width of the element." + }, + { + "name": "height", + "optional": true, + "readonly": false, + "type": "string", + "default": "1rem", + "description": "Height of the element." + }, + { + "name": "borderRadius", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Border radius of the element, defaults to value from theme." + }, + { + "name": "animation", + "optional": true, + "readonly": false, + "type": "\"none\" | \"wave\"", + "default": "wave", + "description": "Type of the animation." } ], "methods": [] @@ -20616,6 +20610,12 @@ "relatedProp": "", "props": [], "methods": [] + }, + "SkeletonEmits": { + "description": "Defines valid emits in Skeleton component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -20637,11 +20637,140 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "SliderSlideEndEvent": { + "description": "Custom slide end event.", + "relatedProp": "SliderEmits.slideend", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Original event" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "New value." + } + ], + "methods": [] + }, + "SliderProps": { + "description": "Defines valid properties in Slider component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "number | number[]", + "default": "", + "description": "Value of the component." + }, + { + "name": "min", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Mininum boundary value." + }, + { + "name": "max", + "optional": true, + "readonly": false, + "type": "number", + "default": "100", + "description": "Maximum boundary value." + }, + { + "name": "orientation", + "optional": true, + "readonly": false, + "type": "\"horizontal\" | \"vertical\"", + "default": "horizontal", + "description": "Orientation of the slider." + }, + { + "name": "step", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Step factor to increment/decrement the value." + }, + { + "name": "range", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When speficed, allows two boundary values to be picked." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the element in tabbing order." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Used to define a string that labels the element." + } + ], + "methods": [] + }, + "SliderSlots": { + "description": "Defines valid slots in Slider component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "SliderEmits": { "description": "Defines valid emits in Slider component.", "relatedProp": "", "props": [], "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number | number[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, { "name": "change", "parameters": [ @@ -20667,137 +20796,8 @@ ], "returnType": "void", "description": "Callback to invoke when slide ends." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number | number[]", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." } ] - }, - "SliderProps": { - "description": "Defines valid properties in Slider component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Used to define a string that labels the element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "max", - "optional": true, - "readonly": false, - "type": "number", - "default": "100", - "description": "Maximum boundary value." - }, - { - "name": "min", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Mininum boundary value." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "number | number[]", - "default": "", - "description": "Value of the component." - }, - { - "name": "orientation", - "optional": true, - "readonly": false, - "type": "\"horizontal\" | \"vertical\"", - "default": "horizontal", - "description": "Orientation of the slider." - }, - { - "name": "range", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When speficed, allows two boundary values to be picked." - }, - { - "name": "step", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Step factor to increment/decrement the value." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the element in tabbing order." - } - ], - "methods": [] - }, - "SliderSlideEndEvent": { - "description": "Custom slide end event.", - "relatedProp": "SliderEmits.slideend", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Original event" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "New value." - } - ], - "methods": [] - }, - "SliderSlots": { - "description": "Defines valid slots in Slider component.", - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -20819,264 +20819,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "SpeedDialEmits": { - "description": "Defines valid emits in SpeedDial component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Fired when the button element clicked." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Fired when the actions are hidden." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Fired when the actions are visible." - } - ] - }, - "SpeedDialProps": { - "description": "Defines valid properties in SpeedDial component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive list element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying list element." - }, - { - "name": "buttonClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the button element." - }, - { - "name": "class", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the element." - }, - { - "name": "direction", - "optional": true, - "readonly": false, - "type": "\"left\" | \"right\" | \"up\" | \"down\" | \"up-left\" | \"up-right\" | \"down-left\" | \"down-right\"", - "default": "up", - "description": "Specifies the opening direction of actions." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the component is disabled." - }, - { - "name": "hideIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Hide icon of the button element." - }, - { - "name": "hideOnClickOutside", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether the actions close when clicked outside." - }, - { - "name": "mask", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to show a mask element behind the speeddial." - }, - { - "name": "maskClass", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class of the mask element." - }, - { - "name": "maskStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the mask element." - }, - { - "name": "model", - "optional": true, - "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "MenuModel instance to define the action items." - }, - { - "name": "radius", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Radius for *circle types." - }, - { - "name": "rotateAnimation", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defined to rotate showIcon when hideIcon is not present." - }, - { - "name": "showIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-plus", - "description": "Show icon of the button element." - }, - { - "name": "style", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the element." - }, - { - "name": "tooltipOptions", - "optional": true, - "readonly": false, - "type": "SpeedDialTooltipOptions", - "default": "", - "description": "Whether to display the tooltip on items. The modifiers of Tooltip can be used like an object in it. Valid keys are 'event' and 'position'." - }, - { - "name": "transitionDelay", - "optional": true, - "readonly": false, - "type": "number", - "default": "30", - "description": "Transition delay step for each action item." - }, - { - "name": "type", - "optional": true, - "readonly": false, - "type": "\"linear\" | \"circle\" | \"semi-circle\" | \"quarter-circle\"", - "default": "linear", - "description": "Specifies the opening type of actions." - }, - { - "name": "visible", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Specifies the visibility of the overlay." - } - ], - "methods": [] - }, - "SpeedDialSlots": { - "description": "Defines valid slots in SpeedDial component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "button", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t toggle(): void, // Toggle metadata\n }", - "description": "button slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom button template." - }, - { - "name": "item", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t item: MenuItem, // Menuitem instance\n }", - "description": "item slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom content for each item." - } - ] - }, "SpeedDialTooltipOptions": { "description": "Defines tooltip options.", "relatedProp": "SpeedDialProps.tooltipOptions", @@ -21105,6 +20847,264 @@ } ], "methods": [] + }, + "SpeedDialProps": { + "description": "Defines valid properties in SpeedDial component.", + "relatedProp": "", + "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "MenuModel instance to define the action items." + }, + { + "name": "visible", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Specifies the visibility of the overlay." + }, + { + "name": "direction", + "optional": true, + "readonly": false, + "type": "\"left\" | \"right\" | \"up\" | \"down\" | \"up-left\" | \"up-right\" | \"down-left\" | \"down-right\"", + "default": "up", + "description": "Specifies the opening direction of actions." + }, + { + "name": "transitionDelay", + "optional": true, + "readonly": false, + "type": "number", + "default": "30", + "description": "Transition delay step for each action item." + }, + { + "name": "type", + "optional": true, + "readonly": false, + "type": "\"linear\" | \"circle\" | \"semi-circle\" | \"quarter-circle\"", + "default": "linear", + "description": "Specifies the opening type of actions." + }, + { + "name": "radius", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Radius for *circle types." + }, + { + "name": "mask", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to show a mask element behind the speeddial." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the component is disabled." + }, + { + "name": "hideOnClickOutside", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether the actions close when clicked outside." + }, + { + "name": "buttonClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the button element." + }, + { + "name": "maskStyle", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the mask element." + }, + { + "name": "maskClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the mask element." + }, + { + "name": "showIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-plus", + "description": "Show icon of the button element." + }, + { + "name": "hideIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Hide icon of the button element." + }, + { + "name": "rotateAnimation", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defined to rotate showIcon when hideIcon is not present." + }, + { + "name": "class", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the element." + }, + { + "name": "style", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the element." + }, + { + "name": "tooltipOptions", + "optional": true, + "readonly": false, + "type": "SpeedDialTooltipOptions", + "default": "", + "description": "Whether to display the tooltip on items. The modifiers of Tooltip can be used like an object in it. Valid keys are 'event' and 'position'." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive list element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying list element." + } + ], + "methods": [] + }, + "SpeedDialSlots": { + "description": "Defines valid slots in SpeedDial component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "item", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each item." + }, + { + "name": "button", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t toggle(): void, // Toggle metadata\n }", + "description": "button slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom button template." + } + ] + }, + "SpeedDialEmits": { + "description": "Defines valid emits in SpeedDial component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Fired when the button element clicked." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Fired when the actions are visible." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Fired when the actions are hidden." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + } + ] } } } @@ -21126,37 +21126,33 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "SplitButtonEmits": { - "description": "Defines valid emits in SplitButton component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when main button is clicked." - } - ] - }, "SplitButtonProps": { "description": "Defines valid properties in SplitButton component.", "relatedProp": "", "props": [ { - "name": "appendTo", + "name": "label", "optional": true, "readonly": false, - "type": "string | HTMLElement", - "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." + "type": "string", + "default": "", + "description": "Text of the button." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the icon." + }, + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "MenuModel instance to define the overlay items." }, { "name": "autoZIndex", @@ -21175,20 +21171,12 @@ "description": "Base zIndex value to use in layering." }, { - "name": "buttonProps", + "name": "appendTo", "optional": true, "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the default button." - }, - { - "name": "class", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the component." + "type": "string | HTMLElement", + "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." }, { "name": "disabled", @@ -21199,28 +21187,28 @@ "description": "When present, it specifies that the element should be disabled." }, { - "name": "icon", + "name": "class", "optional": true, "readonly": false, - "type": "string", + "type": "any", "default": "", - "description": "Name of the icon." + "description": "Style class of the component." }, { - "name": "label", + "name": "style", "optional": true, "readonly": false, - "type": "string", + "type": "any", "default": "", - "description": "Text of the button." + "description": "Inline style of the component." }, { - "name": "menuButtonIcon", + "name": "buttonProps", "optional": true, "readonly": false, - "type": "string", + "type": "ButtonHTMLAttributes", "default": "", - "description": "Name of the menu button icon." + "description": "Uses to pass all properties of the HTMLButtonElement to the default button." }, { "name": "menuButtonProps", @@ -21231,28 +21219,20 @@ "description": "Uses to pass all properties of the HTMLButtonElement to the menu button." }, { - "name": "model", + "name": "menuButtonIcon", "optional": true, "readonly": false, - "type": "MenuItem[]", + "type": "string", "default": "", - "description": "MenuModel instance to define the overlay items." + "description": "Name of the menu button icon." }, { - "name": "outlined", + "name": "severity", "optional": true, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Add a border class without a background initially." - }, - { - "name": "plain", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Add a plain textual class to the button without a background initially." + "type": "string", + "default": "", + "description": "Defines the style of the button." }, { "name": "raised", @@ -21271,12 +21251,20 @@ "description": "Add a circular border radius to the button." }, { - "name": "severity", + "name": "text", "optional": true, "readonly": false, - "type": "string", - "default": "", - "description": "Defines the style of the button." + "type": "boolean", + "default": "false", + "description": "Add a textual class to the button without a background initially." + }, + { + "name": "outlined", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a border class without a background initially." }, { "name": "size", @@ -21287,20 +21275,12 @@ "description": "Defines the size of the button." }, { - "name": "style", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the component." - }, - { - "name": "text", + "name": "plain", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Add a textual class to the button without a background initially." + "description": "Add a plain textual class to the button without a background initially." } ], "methods": [] @@ -21317,6 +21297,26 @@ "description": "Button part of the content can easily be customized with the default slot instead of using the built-in modes." } ] + }, + "SplitButtonEmits": { + "description": "Defines valid emits in SplitButton component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when main button is clicked." + } + ] } } } @@ -21338,52 +21338,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "SplitterEmits": { - "description": "Defines valid emits in Splitter component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "resizeend", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "SplitterResizeEndEvent", - "description": "Custom resize end event." - } - ], - "returnType": "void", - "description": "Callback to invoke when resize ends." - }, - { - "name": "resizestar", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "SplitterResizeStartEvent", - "description": "Custom resize start event." - } - ], - "returnType": "void", - "description": "Callback to invoke when resize starts." - } - ] - }, - "SplitterPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "SplitterPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -21405,115 +21359,6 @@ ], "methods": [] }, - "SplitterPassThroughOptions": { - "description": "Custom passthrough(pt) options.", - "relatedProp": "SplitterProps.pt", - "props": [ - { - "name": "gutter", - "optional": true, - "readonly": false, - "type": "SplitterPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the gutter's DOM element." - }, - { - "name": "gutterhandler", - "optional": true, - "readonly": false, - "type": "SplitterPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the gutter handler's DOM element." - }, - { - "name": "root", - "optional": true, - "readonly": false, - "type": "SplitterPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the root's DOM element." - } - ], - "methods": [] - }, - "SplitterProps": { - "description": "Defines valid properties in Splitter component.", - "relatedProp": "", - "props": [ - { - "name": "gutterSize", - "optional": true, - "readonly": false, - "type": "number", - "default": "4", - "description": "Size of the divider in pixels." - }, - { - "name": "layout", - "optional": true, - "readonly": false, - "type": "\"horizontal\" | \"vertical\"", - "default": "horizontal", - "description": "Orientation of the panels." - }, - { - "name": "pt", - "optional": true, - "readonly": false, - "type": "SplitterPassThroughOptions", - "default": "", - "description": "Uses to pass attributes to DOM elements inside the component." - }, - { - "name": "stateKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Storage identifier of a stateful Splitter." - }, - { - "name": "stateStorage", - "optional": true, - "readonly": false, - "type": "\"local\" | \"session\"", - "default": "session", - "description": "Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage." - }, - { - "name": "step", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Step factor to increment/decrement the size of the panels while pressing the arrow keys." - } - ], - "methods": [] - }, - "SplitterResizeEndEvent": { - "description": "Custom resize end event.", - "relatedProp": "undefined.PickListEmits.resizeend", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event" - }, - { - "name": "sizes", - "optional": false, - "readonly": false, - "type": "number[]", - "default": "", - "description": "Sizes of the panels" - } - ], - "methods": [] - }, "SplitterResizeStartEvent": { "description": "Custom resize start event.", "relatedProp": "SplitterEmits.resizestar", @@ -21537,18 +21382,72 @@ ], "methods": [] }, - "SplitterSlots": { - "description": "Defines valid slots in Splitter slots.", - "relatedProp": "", - "props": [], - "methods": [ + "SplitterResizeEndEvent": { + "description": "Custom resize end event.", + "relatedProp": "undefined.PickListEmits.resizeend", + "props": [ { - "name": "default", - "parameters": [], - "returnType": "VNode[]", - "description": "Default slot to detect SplitterPanel components." + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "sizes", + "optional": false, + "readonly": false, + "type": "number[]", + "default": "", + "description": "Sizes of the panels" } - ] + ], + "methods": [] + }, + "SplitterPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "SplitterProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "SplitterPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "gutter", + "optional": true, + "readonly": false, + "type": "SplitterPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the gutter's DOM element." + }, + { + "name": "gutterhandler", + "optional": true, + "readonly": false, + "type": "SplitterPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the gutter handler's DOM element." + } + ], + "methods": [] + }, + "SplitterPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] }, "SplitterState": { "description": "Defines current inline state in Panel component.", @@ -21564,6 +21463,107 @@ } ], "methods": [] + }, + "SplitterProps": { + "description": "Defines valid properties in Splitter component.", + "relatedProp": "", + "props": [ + { + "name": "layout", + "optional": true, + "readonly": false, + "type": "\"horizontal\" | \"vertical\"", + "default": "horizontal", + "description": "Orientation of the panels." + }, + { + "name": "gutterSize", + "optional": true, + "readonly": false, + "type": "number", + "default": "4", + "description": "Size of the divider in pixels." + }, + { + "name": "stateKey", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Storage identifier of a stateful Splitter." + }, + { + "name": "stateStorage", + "optional": true, + "readonly": false, + "type": "\"local\" | \"session\"", + "default": "session", + "description": "Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage." + }, + { + "name": "step", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Step factor to increment/decrement the size of the panels while pressing the arrow keys." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "SplitterPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." + } + ], + "methods": [] + }, + "SplitterSlots": { + "description": "Defines valid slots in Splitter slots.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "default", + "parameters": [], + "returnType": "VNode[]", + "description": "Default slot to detect SplitterPanel components." + } + ] + }, + "SplitterEmits": { + "description": "Defines valid emits in Splitter component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "resizestar", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "SplitterResizeStartEvent", + "description": "Custom resize start event." + } + ], + "returnType": "void", + "description": "Callback to invoke when resize starts." + }, + { + "name": "resizeend", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "SplitterResizeEndEvent", + "description": "Custom resize end event." + } + ], + "returnType": "void", + "description": "Callback to invoke when resize ends." + } + ] } } }, @@ -21593,24 +21593,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "SplitterPanelEmits": { - "relatedProp": "", - "props": [], - "methods": [] - }, - "SplitterPanelPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "SplitterPanelPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -21640,10 +21622,31 @@ ], "methods": [] }, + "SplitterPanelPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, "SplitterPanelProps": { "description": "Defines valid properties in SplitterPanel component.", "relatedProp": "", "props": [ + { + "name": "size", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Size of the element relative to 100%." + }, { "name": "minSize", "optional": true, @@ -21659,14 +21662,6 @@ "type": "SplitterPanelPassThroughOptions", "default": "", "description": "Uses to pass attributes to DOM elements inside the component." - }, - { - "name": "size", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Size of the element relative to 100%." } ], "methods": [] @@ -21684,6 +21679,11 @@ } ], "methods": [] + }, + "SplitterPanelEmits": { + "relatedProp": "", + "props": [], + "methods": [] } } }, @@ -21713,24 +21713,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "StepsEmits": { - "description": "Defines valid emits in Steps component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "StepsProps": { "description": "Defines valid properties in Steps component.", "relatedProp": "", "props": [ - { - "name": "exact", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." - }, { "name": "id", "optional": true, @@ -21754,6 +21740,14 @@ "type": "boolean", "default": "true", "description": "Whether the items are clickable or not." + }, + { + "name": "exact", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." } ], "methods": [] @@ -21777,6 +21771,12 @@ "description": "Custom item template." } ] + }, + "StepsEmits": { + "description": "Defines valid emits in Steps component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -21789,6 +21789,85 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "StyleClassOptions": { + "description": "Defines options of StyleClass.", + "relatedProp": "", + "props": [ + { + "name": "selector", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Selector to define the target element. Available selectors are '@next', '@prev', '@parent' and '@grandparent'." + }, + { + "name": "enterClassName", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class to add when item begins to get displayed." + }, + { + "name": "enterActiveClassName", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class to add during enter animation." + }, + { + "name": "enterToClassName", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class to add when item begins to get displayed." + }, + { + "name": "leaveClassName", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class to add when item begins to get hidden." + }, + { + "name": "leaveActiveClassName", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class to add during leave animation." + }, + { + "name": "leaveToClassName", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class to add when leave animation is completed." + }, + { + "name": "hideOnOutsideClick", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to trigger leave animation when outside of the element is clicked." + }, + { + "name": "toggleClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Adds or removes a class when no enter-leave animation is required." + } + ], + "methods": [] + }, "StyleClassDirectiveBinding": { "description": "Binding of StyleClass directive.", "relatedProp": "", @@ -21804,85 +21883,6 @@ ], "methods": [], "extendedTypes": "Omit" - }, - "StyleClassOptions": { - "description": "Defines options of StyleClass.", - "relatedProp": "", - "props": [ - { - "name": "enterActiveClassName", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class to add during enter animation." - }, - { - "name": "enterClassName", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class to add when item begins to get displayed." - }, - { - "name": "enterToClassName", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class to add when item begins to get displayed." - }, - { - "name": "hideOnOutsideClick", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to trigger leave animation when outside of the element is clicked." - }, - { - "name": "leaveActiveClassName", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class to add during leave animation." - }, - { - "name": "leaveClassName", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class to add when item begins to get hidden." - }, - { - "name": "leaveToClassName", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class to add when leave animation is completed." - }, - { - "name": "selector", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Selector to define the target element. Available selectors are '@next', '@prev', '@parent' and '@grandparent'." - }, - { - "name": "toggleClass", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Adds or removes a class when no enter-leave animation is required." - } - ], - "methods": [] } } } @@ -21908,14 +21908,6 @@ "description": "Custom change event.", "relatedProp": "TabMenuEmits['tab-change']", "props": [ - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the selected tab" - }, { "name": "originalEvent", "optional": false, @@ -21923,34 +21915,38 @@ "type": "Event", "default": "", "description": "Browser event" + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the selected tab" } ], "methods": [] }, - "TabMenuEmits": { - "description": "Defines valid emits in TabMenu component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "tab-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "TabMenuChangeEvent", - "description": "Custom tab change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when an active tab is changed." - } - ] - }, "TabMenuProps": { "description": "Defines valid properties in TabMenu component.", "relatedProp": "", "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "An array of menuitems." + }, + { + "name": "exact", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines if active route highlight should match the exact route path." + }, { "name": "activeIndex", "optional": true, @@ -21974,22 +21970,6 @@ "type": "string", "default": "", "description": "Identifier of the underlying input element." - }, - { - "name": "exact", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines if active route highlight should match the exact route path." - }, - { - "name": "model", - "optional": true, - "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "An array of menuitems." } ], "methods": [] @@ -22013,6 +21993,26 @@ "description": "Custom content for each item." } ] + }, + "TabMenuEmits": { + "description": "Defines valid emits in TabMenu component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "tab-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "TabMenuChangeEvent", + "description": "Custom tab change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when an active tab is changed." + } + ] } } } @@ -22034,40 +22034,23 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "TabPanelEmits": { - "relatedProp": "", - "props": [], - "methods": [] - }, - "TabPanelPassThroughAttributes": { - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "TabPanelPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", "props": [ - { - "name": "parent", - "optional": false, - "readonly": false, - "type": "TabViewPassThroughOptions", - "default": "" - }, { "name": "props", "optional": false, "readonly": false, "type": "TabPanelProps", "default": "" + }, + { + "name": "parent", + "optional": false, + "readonly": false, + "type": "TabViewPassThroughOptions", + "default": "" } ], "methods": [] @@ -22077,12 +22060,12 @@ "relatedProp": "TabPanelProps.pt", "props": [ { - "name": "content", + "name": "root", "optional": true, "readonly": false, "type": "TabPanelPassThroughOptionType", "default": "", - "description": "Uses to pass attributes to the list's DOM element." + "description": "Uses to pass attributes to the root's DOM element." }, { "name": "header", @@ -22109,12 +22092,24 @@ "description": "Uses to pass attributes to the title's DOM element." }, { - "name": "root", + "name": "content", "optional": true, "readonly": false, "type": "TabPanelPassThroughOptionType", "default": "", - "description": "Uses to pass attributes to the root's DOM element." + "description": "Uses to pass attributes to the list's DOM element." + } + ], + "methods": [] + }, + "TabPanelPassThroughAttributes": { + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" } ], "methods": [] @@ -22123,41 +22118,6 @@ "description": "Defines valid properties in TabPanel component.", "relatedProp": "", "props": [ - { - "name": "contentClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the tab content.", - "deprecated": "since v3.26.0. Use 'pt' property instead." - }, - { - "name": "contentProps", - "optional": true, - "readonly": false, - "type": "HTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLDivElement to the tab content.", - "deprecated": "since v3.26.0. Use 'pt' property instead." - }, - { - "name": "contentStyle", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the tab content.", - "deprecated": "since v3.26.0. Use 'pt' property instead." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the tab is disabled." - }, { "name": "header", "optional": true, @@ -22167,12 +22127,12 @@ "description": "Orientation of tab headers." }, { - "name": "headerActionProps", + "name": "headerStyle", "optional": true, "readonly": false, - "type": "AnchorHTMLAttributes", + "type": "any", "default": "", - "description": "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.", + "description": "Inline style of the tab header.", "deprecated": "since v3.26.0. Use 'pt' property instead." }, { @@ -22194,14 +22154,49 @@ "deprecated": "since v3.26.0. Use 'pt' property instead." }, { - "name": "headerStyle", + "name": "headerActionProps", + "optional": true, + "readonly": false, + "type": "AnchorHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.", + "deprecated": "since v3.26.0. Use 'pt' property instead." + }, + { + "name": "contentStyle", "optional": true, "readonly": false, "type": "any", "default": "", - "description": "Inline style of the tab header.", + "description": "Inline style of the tab content.", "deprecated": "since v3.26.0. Use 'pt' property instead." }, + { + "name": "contentClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the tab content.", + "deprecated": "since v3.26.0. Use 'pt' property instead." + }, + { + "name": "contentProps", + "optional": true, + "readonly": false, + "type": "HTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLDivElement to the tab content.", + "deprecated": "since v3.26.0. Use 'pt' property instead." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the tab is disabled." + }, { "name": "pt", "optional": true, @@ -22233,6 +22228,11 @@ } ], "methods": [] + }, + "TabPanelEmits": { + "relatedProp": "", + "props": [], + "methods": [] } } }, @@ -22266,14 +22266,6 @@ "description": "Custom tab change event.", "relatedProp": "TabViewEmits['tab-change']", "props": [ - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the selected tab" - }, { "name": "originalEvent", "optional": false, @@ -22281,6 +22273,14 @@ "type": "Event", "default": "", "description": "Browser event" + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the selected tab" } ], "methods": [], @@ -22290,14 +22290,6 @@ "description": "Custom tab change event.", "relatedProp": "TabViewEmits['tab-click']", "props": [ - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of the selected tab" - }, { "name": "originalEvent", "optional": false, @@ -22305,89 +22297,30 @@ "type": "Event", "default": "", "description": "Browser event" + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the selected tab" } ], "methods": [], "extendedTypes": "TabViewChangeEvent" }, - "TabViewEmits": { - "description": "Defines valid emits in TabView component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "tab-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "TabViewChangeEvent", - "description": "Custom tab change event." - } - ], - "returnType": "void", - "description": "Callback to invoke when an active tab is changed." - }, - { - "name": "tab-click", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "TabViewClickEvent", - "description": "Custom tab click event." - } - ], - "returnType": "void", - "description": "Callback to invoke when an active tab is clicked." - }, - { - "name": "update:modelValue", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the value changes." - } - ] - }, - "TabViewPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "TabViewPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "TabViewProps.pt", "props": [ { - "name": "inkbar", + "name": "root", "optional": true, "readonly": false, "type": "TabViewPassThroughOptionType", "default": "", - "description": "Uses to pass attributes to the inkbar's DOM element." - }, - { - "name": "nav", - "optional": true, - "readonly": false, - "type": "TabViewPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the list's DOM element." + "description": "Uses to pass attributes to the root's DOM element." }, { "name": "navcontainer", @@ -22405,6 +22338,38 @@ "default": "", "description": "Uses to pass attributes to the nav content's DOM element." }, + { + "name": "nav", + "optional": true, + "readonly": false, + "type": "TabViewPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the list's DOM element." + }, + { + "name": "inkbar", + "optional": true, + "readonly": false, + "type": "TabViewPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the inkbar's DOM element." + }, + { + "name": "prevbutton", + "optional": true, + "readonly": false, + "type": "TabViewPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the previous button's DOM element." + }, + { + "name": "previcon", + "optional": true, + "readonly": false, + "type": "TabViewPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the previous button icon's DOM element." + }, { "name": "nextbutton", "optional": true, @@ -22428,30 +22393,58 @@ "type": "TabViewPassThroughOptionType", "default": "", "description": "Uses to pass attributes to the panel's DOM element." + } + ], + "methods": [] + }, + "TabViewPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "TabViewState": { + "description": "Defines current inline state in TabView component.", + "relatedProp": "", + "props": [ + { + "name": "d_activeIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Current active index state." }, { - "name": "prevbutton", - "optional": true, + "name": "id", + "optional": false, "readonly": false, - "type": "TabViewPassThroughOptionType", + "type": "string", "default": "", - "description": "Uses to pass attributes to the previous button's DOM element." + "description": "Unique id for the TabView component." }, { - "name": "previcon", - "optional": true, + "name": "isPrevButtonDisabled", + "optional": false, "readonly": false, - "type": "TabViewPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the previous button icon's DOM element." + "type": "boolean", + "default": "true", + "description": "Current state of previous button." }, { - "name": "root", - "optional": true, + "name": "isNextButtonDisabled", + "optional": false, "readonly": false, - "type": "TabViewPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the root's DOM element." + "type": "boolean", + "default": "false", + "description": "Current state of the next button." } ], "methods": [] @@ -22477,13 +22470,28 @@ "description": "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css." }, { - "name": "nextButtonProps", + "name": "scrollable", "optional": true, "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the next button.", - "deprecated": "since v3.26.0. Use 'pt' property instead." + "type": "boolean", + "default": "false", + "description": "When enabled displays buttons at each side of the tab headers to scroll the tab list." + }, + { + "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": "previousButtonProps", @@ -22494,6 +22502,15 @@ "description": "Uses to pass all properties of the HTMLButtonElement to the previous button.", "deprecated": "since v3.26.0. Use 'pt' property instead." }, + { + "name": "nextButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the next button.", + "deprecated": "since v3.26.0. Use 'pt' property instead." + }, { "name": "pt", "optional": true, @@ -22501,30 +22518,6 @@ "type": "TabViewPassThroughOptions", "default": "", "description": "Uses to pass attributes to DOM elements inside the component." - }, - { - "name": "scrollable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled displays buttons at each side of the tab headers to scroll the tab list." - }, - { - "name": "selectOnFocus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, the focused tab is activated." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Index of the element in tabbing order." } ], "methods": [] @@ -22540,58 +22533,65 @@ "returnType": "VNode[]", "description": "Default slot to detect TabPanel components." }, - { - "name": "nexticon", - "parameters": [], - "returnType": "VNode[]", - "description": "Next button icon template for the scrollable component." - }, { "name": "previcon", "parameters": [], "returnType": "VNode[]", "description": "Previous button icon template for the scrollable component." + }, + { + "name": "nexticon", + "parameters": [], + "returnType": "VNode[]", + "description": "Next button icon template for the scrollable component." } ] }, - "TabViewState": { - "description": "Defines current inline state in TabView component.", + "TabViewEmits": { + "description": "Defines valid emits in TabView component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { - "name": "d_activeIndex", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Current active index state." + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." }, { - "name": "id", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Unique id for the TabView component." + "name": "tab-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "TabViewChangeEvent", + "description": "Custom tab change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when an active tab is changed." }, { - "name": "isNextButtonDisabled", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current state of the next button." - }, - { - "name": "isPrevButtonDisabled", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Current state of previous button." + "name": "tab-click", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "TabViewClickEvent", + "description": "Custom tab click event." + } + ], + "returnType": "void", + "description": "Callback to invoke when an active tab is clicked." } - ], - "methods": [] + ] } } }, @@ -22621,31 +22621,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "TagEmits": { - "description": "Defines valid emits in Tag component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "TagProps": { "description": "Defines valid properties in Tag component.", "relatedProp": "", "props": [ { - "name": "icon", + "name": "value", "optional": true, "readonly": false, - "type": "string", + "type": "any", "default": "", - "description": "Icon of the tag to display next to the value." - }, - { - "name": "rounded", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the corners of the tag are rounded." + "description": "Value to display inside the tag." }, { "name": "severity", @@ -22656,12 +22642,20 @@ "description": "Severity type of the tag." }, { - "name": "value", + "name": "rounded", "optional": true, "readonly": false, - "type": "any", + "type": "boolean", + "default": "false", + "description": "Whether the corners of the tag are rounded." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "string", "default": "", - "description": "Value to display inside the tag." + "description": "Icon of the tag to display next to the value." } ], "methods": [] @@ -22678,6 +22672,12 @@ "description": "Custom content template" } ] + }, + "TagEmits": { + "description": "Defines valid emits in Tag component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -22699,24 +22699,10 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "TerminalEmits": { - "description": "Defines valid emits in Terminal component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "TerminalProps": { "description": "Defines valid properties in Terminal component.", "relatedProp": "", "props": [ - { - "name": "prompt", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Prompt text for each command." - }, { "name": "welcomeMessage", "optional": true, @@ -22724,6 +22710,14 @@ "type": "string", "default": "", "description": "Initial text to display on terminal." + }, + { + "name": "prompt", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Prompt text for each command." } ], "methods": [] @@ -22733,6 +22727,12 @@ "relatedProp": "", "props": [], "methods": [] + }, + "TerminalEmits": { + "description": "Defines valid emits in Terminal component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -22749,6 +22749,23 @@ "methods": { "description": "", "values": [ + { + "name": "on", + "parameters": [ + { + "name": "action", + "optional": false, + "type": "undefined | \"command\" | \"response\"" + }, + { + "name": "fn", + "optional": false, + "type": "any" + } + ], + "returnType": "void", + "description": "Displays the terminal using the action options." + }, { "name": "emit", "parameters": [ @@ -22782,23 +22799,6 @@ ], "returnType": "void", "description": "Closes the terminal using the action options." - }, - { - "name": "on", - "parameters": [ - { - "name": "action", - "optional": false, - "type": "undefined | \"command\" | \"response\"" - }, - { - "name": "fn", - "optional": false, - "type": "any" - } - ], - "returnType": "void", - "description": "Displays the terminal using the action options." } ] } @@ -22822,6 +22822,36 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "TextareaProps": { + "description": "Defines valid properties in Textarea component. In addition to these, all properties of TextareaHTMLAttributes can be used in this component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Value of the component." + }, + { + "name": "autoResize", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, height of textarea changes as being typed." + } + ], + "methods": [], + "extendedTypes": "TextareaHTMLAttributes" + }, + "TextareaSlots": { + "description": "Defines valid slots in Textarea component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "TextareaEmits": { "description": "Defines valid emits in Textarea component.", "relatedProp": "", @@ -22835,36 +22865,6 @@ } ], "methods": [] - }, - "TextareaProps": { - "description": "Defines valid properties in Textarea component. In addition to these, all properties of TextareaHTMLAttributes can be used in this component.", - "relatedProp": "", - "props": [ - { - "name": "autoResize", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, height of textarea changes as being typed." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Value of the component." - } - ], - "methods": [], - "extendedTypes": "TextareaHTMLAttributes" - }, - "TextareaSlots": { - "description": "Defines valid slots in Textarea component.", - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -22893,67 +22893,26 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "TieredMenuEmits": { - "description": "Defines valid emits in TieredMenuMenu component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "before-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the popup is hidden." - }, - { - "name": "before-show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the popup is shown." - }, - { - "name": "blur", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component loses focus." - }, - { - "name": "focus", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when the component receives focus." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the popup is hidden." - }, - { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the popup is shown." - } - ] - }, "TieredMenuProps": { "description": "Defines valid properties in TieredMenuMenu component.", "relatedProp": "", "props": [ + { + "name": "model", + "optional": true, + "readonly": false, + "type": "MenuItem[]", + "default": "", + "description": "An array of menuitems." + }, + { + "name": "popup", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if menu would displayed as a popup." + }, { "name": "appendTo", "optional": true, @@ -22962,22 +22921,6 @@ "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying menu element." - }, { "name": "autoZIndex", "optional": true, @@ -22994,14 +22937,6 @@ "default": "0", "description": "Base zIndex value to use in layering." }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, { "name": "exact", "optional": true, @@ -23011,20 +22946,12 @@ "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { - "name": "model", - "optional": true, - "readonly": false, - "type": "MenuItem[]", - "default": "", - "description": "An array of menuitems." - }, - { - "name": "popup", + "name": "disabled", "optional": true, "readonly": false, "type": "boolean", "default": "false", - "description": "Defines if menu would displayed as a popup." + "description": "When present, it specifies that the component should be disabled." }, { "name": "tabindex", @@ -23033,6 +22960,22 @@ "type": "string | number", "default": "", "description": "Index of the element in tabbing order." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying menu element." } ], "methods": [] @@ -23056,6 +22999,63 @@ "description": "Custom content for each item." } ] + }, + "TieredMenuEmits": { + "description": "Defines valid emits in TieredMenuMenu component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "before-show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the popup is shown." + }, + { + "name": "before-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the popup is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the popup is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the popup is hidden." + } + ] } } } @@ -23077,16 +23077,18 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "TimelineEmits": { - "description": "Defines valid emits in Timeline component.", - "relatedProp": "", - "props": [], - "methods": [] - }, "TimelineProps": { "description": "Defines valid properties in Timeline component.", "relatedProp": "", "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "any[]", + "default": "", + "description": "An array of events to display." + }, { "name": "align", "optional": true, @@ -23095,14 +23097,6 @@ "default": "left", "description": "Position of the timeline bar relative to the content." }, - { - "name": "dataKey", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Name of the field that uniquely identifies the a record in the data." - }, { "name": "layout", "optional": true, @@ -23112,12 +23106,12 @@ "description": "Orientation of the timeline." }, { - "name": "value", + "name": "dataKey", "optional": true, "readonly": false, - "type": "any[]", + "type": "string", "default": "", - "description": "An array of events to display." + "description": "Name of the field that uniquely identifies the a record in the data." } ], "methods": [] @@ -23127,38 +23121,39 @@ "relatedProp": "", "props": [], "methods": [ - { - "name": "connector", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }" - } - ], - "returnType": "VNode[]", - "description": "Custom connector template." - }, { "name": "content", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }", + "type": "{\n \t item: any, // Item data\n \t index: number, // Index of item\n }", "description": "content slot's params." } ], "returnType": "VNode[]", "description": "Custom content template" }, + { + "name": "opposite", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t item: any, // Item data\n \t index: number, // Index of item\n }", + "description": "opposite slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom opposite template." + }, { "name": "marker", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }", + "type": "{\n \t item: any, // Item data\n \t index: number, // Index of item\n }", "description": "marker slot's params." } ], @@ -23166,19 +23161,24 @@ "description": "Custom marker template." }, { - "name": "opposite", + "name": "connector", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }", - "description": "opposite slot's params." + "type": "{\n \t item: any, // Item data\n \t index: number, // Index of item\n }" } ], "returnType": "VNode[]", - "description": "Custom opposite template." + "description": "Custom connector template." } ] + }, + "TimelineEmits": { + "description": "Defines valid emits in Timeline component.", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -23200,6 +23200,77 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ToastMessageOptions": { + "description": "Defines message options in Toast component.", + "relatedProp": "", + "props": [ + { + "name": "severity", + "optional": true, + "readonly": false, + "type": "string", + "default": "info", + "description": "Severity level of the message." + }, + { + "name": "summary", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Summary content of the message." + }, + { + "name": "detail", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Detail content of the message." + }, + { + "name": "closable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether the message can be closed manually using the close icon." + }, + { + "name": "life", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Delay in milliseconds to close the message automatically." + }, + { + "name": "group", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Key of the Toast to display the message." + }, + { + "name": "styleClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the message." + }, + { + "name": "contentStyleClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the content." + } + ], + "methods": [] + }, "ToastBreakpointsType": { "description": "Defines breakpoints type in Toast component.", "relatedProp": "", @@ -23213,6 +23284,121 @@ ], "methods": [] }, + "ToastProps": { + "description": "Defines valid properties in Toast component.", + "relatedProp": "", + "props": [ + { + "name": "group", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Unique identifier of a message group." + }, + { + "name": "position", + "optional": true, + "readonly": false, + "type": "\"center\" | \"top-left\" | \"top-center\" | \"top-right\" | \"bottom-left\" | \"bottom-center\" | \"bottom-right\"", + "default": "top-right", + "description": "Position of the toast in viewport." + }, + { + "name": "autoZIndex", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to automatically manage layering." + }, + { + "name": "baseZIndex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Base zIndex value to use in layering." + }, + { + "name": "breakpoints", + "optional": true, + "readonly": false, + "type": "ToastBreakpointsType", + "default": "", + "description": "Object literal to define styles per screen size." + }, + { + "name": "closeIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times", + "description": "Icon to display in the toast close button." + }, + { + "name": "infoIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-info-circle", + "description": "Icon to display in the toast with info severity." + }, + { + "name": "warnIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-exclamation-triangle", + "description": "Icon to display in the toast with warn severity." + }, + { + "name": "errorIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-times", + "description": "Icon to display in the toast with error severity." + }, + { + "name": "successIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-check", + "description": "Icon to display in the toast with success severity." + }, + { + "name": "closeButtonProps", + "optional": true, + "readonly": false, + "type": "ButtonHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLButtonElement to the close button." + } + ], + "methods": [] + }, + "ToastSlots": { + "description": "Defines valid slot in Toast component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "message", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "{\n \t message: any, // Message of the component\n }", + "description": "message slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom message template." + } + ] + }, "ToastEmits": { "description": "Defines valid emits in Toast component.", "relatedProp": "", @@ -23245,192 +23431,6 @@ "description": "Callback to invoke when the toast's timeout is over." } ] - }, - "ToastMessageOptions": { - "description": "Defines message options in Toast component.", - "relatedProp": "", - "props": [ - { - "name": "closable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether the message can be closed manually using the close icon." - }, - { - "name": "contentStyleClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the content." - }, - { - "name": "detail", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Detail content of the message." - }, - { - "name": "group", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Key of the Toast to display the message." - }, - { - "name": "life", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Delay in milliseconds to close the message automatically." - }, - { - "name": "severity", - "optional": true, - "readonly": false, - "type": "string", - "default": "info", - "description": "Severity level of the message." - }, - { - "name": "styleClass", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the message." - }, - { - "name": "summary", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Summary content of the message." - } - ], - "methods": [] - }, - "ToastProps": { - "description": "Defines valid properties in Toast component.", - "relatedProp": "", - "props": [ - { - "name": "autoZIndex", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to automatically manage layering." - }, - { - "name": "baseZIndex", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Base zIndex value to use in layering." - }, - { - "name": "breakpoints", - "optional": true, - "readonly": false, - "type": "ToastBreakpointsType", - "default": "", - "description": "Object literal to define styles per screen size." - }, - { - "name": "closeButtonProps", - "optional": true, - "readonly": false, - "type": "ButtonHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the close button." - }, - { - "name": "closeIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times", - "description": "Icon to display in the toast close button." - }, - { - "name": "errorIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-times", - "description": "Icon to display in the toast with error severity." - }, - { - "name": "group", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Unique identifier of a message group." - }, - { - "name": "infoIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-info-circle", - "description": "Icon to display in the toast with info severity." - }, - { - "name": "position", - "optional": true, - "readonly": false, - "type": "\"center\" | \"top-left\" | \"top-center\" | \"top-right\" | \"bottom-left\" | \"bottom-center\" | \"bottom-right\"", - "default": "top-right", - "description": "Position of the toast in viewport." - }, - { - "name": "successIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-check", - "description": "Icon to display in the toast with success severity." - }, - { - "name": "warnIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-exclamation-triangle", - "description": "Icon to display in the toast with warn severity." - } - ], - "methods": [] - }, - "ToastSlots": { - "description": "Defines valid slot in Toast component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "message", - "parameters": [ - { - "name": "scope", - "optional": false, - "type": "{\n \t message: any, // Message of the component\n }", - "description": "message slot's params." - } - ], - "returnType": "VNode[]", - "description": "Custom message template." - } - ] } } } @@ -23460,12 +23460,6 @@ "returnType": "void", "description": "Displays the message in a suitable Toast component." }, - { - "name": "removeAllGroups", - "parameters": [], - "returnType": "void", - "description": "Clears all the messages." - }, { "name": "removeGroup", "parameters": [ @@ -23478,6 +23472,12 @@ ], "returnType": "void", "description": "Clears the messages that belongs to the group." + }, + { + "name": "removeAllGroups", + "parameters": [], + "returnType": "void", + "description": "Clears all the messages." } ] } @@ -23501,23 +23501,148 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ToggleButtonProps": { + "description": "Defines valid properties in ToggleButton component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Value of the component." + }, + { + "name": "onIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Icon for the on state." + }, + { + "name": "offIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Icon for the off state." + }, + { + "name": "onLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "yes", + "description": "Label for the on state." + }, + { + "name": "offLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "no", + "description": "Label for the off state." + }, + { + "name": "iconPos", + "optional": true, + "readonly": false, + "type": "\"left\" | \"right\"", + "default": "left", + "description": "Position of the icon." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the element should be disabled." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Index of the element in tabbing order." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the focus input to match a label defined for the chips." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." + } + ], + "methods": [] + }, + "ToggleButtonSlots": { + "description": "Defines valid slots in ToggleButton component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ToggleButtonEmits": { "description": "Defines valid emits in ToggleButton component.", "relatedProp": "", "props": [], "methods": [ { - "name": "blur", + "name": "update:modelValue", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "Event", - "description": "Browser event." + "type": "boolean", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when the component loses focus." + "description": "Emitted when the value changes." }, { "name": "change", @@ -23546,144 +23671,19 @@ "description": "Callback to invoke when the component receives focus." }, { - "name": "update:modelValue", + "name": "blur", "parameters": [ { - "name": "value", + "name": "event", "optional": false, - "type": "boolean", - "description": "New value." + "type": "Event", + "description": "Browser event." } ], "returnType": "void", - "description": "Emitted when the value changes." + "description": "Callback to invoke when the component loses focus." } ] - }, - "ToggleButtonProps": { - "description": "Defines valid properties in ToggleButton component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the element should be disabled." - }, - { - "name": "iconPos", - "optional": true, - "readonly": false, - "type": "\"left\" | \"right\"", - "default": "left", - "description": "Position of the icon." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the focus input to match a label defined for the chips." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Value of the component." - }, - { - "name": "offIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Icon for the off state." - }, - { - "name": "offLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "no", - "description": "Label for the off state." - }, - { - "name": "onIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Icon for the on state." - }, - { - "name": "onLabel", - "optional": true, - "readonly": false, - "type": "string", - "default": "yes", - "description": "Label for the on state." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Index of the element in tabbing order." - } - ], - "methods": [] - }, - "ToggleButtonSlots": { - "description": "Defines valid slots in ToggleButton component.", - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -23705,25 +23705,6 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "ToolbarEmits": { - "description": "Defines valid emits in Toolbar component.", - "relatedProp": "", - "props": [], - "methods": [] - }, - "ToolbarPassThroughAttributes": { - "description": "Custom passthrough attributes for each DOM elements", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, "ToolbarPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -23743,12 +23724,12 @@ "relatedProp": "ToolbarProps.pt", "props": [ { - "name": "groupcenter", + "name": "root", "optional": true, "readonly": false, "type": "ToolbarPassThroughOptionType", "default": "", - "description": "Uses to pass attributes to the groupcenter's DOM element." + "description": "Uses to pass attributes to the root's DOM element." }, { "name": "groupleft", @@ -23758,6 +23739,14 @@ "default": "", "description": "Uses to pass attributes to the groupleft's DOM element." }, + { + "name": "groupcenter", + "optional": true, + "readonly": false, + "type": "ToolbarPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the groupcenter's DOM element." + }, { "name": "groupright", "optional": true, @@ -23765,14 +23754,19 @@ "type": "ToolbarPassThroughOptionType", "default": "", "description": "Uses to pass attributes to the groupright's DOM element." - }, + } + ], + "methods": [] + }, + "ToolbarPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ { - "name": "root", - "optional": true, + "name": "[key: string]", + "optional": false, "readonly": false, - "type": "ToolbarPassThroughOptionType", - "default": "", - "description": "Uses to pass attributes to the root's DOM element." + "type": "any" } ], "methods": [] @@ -23805,6 +23799,12 @@ "relatedProp": "", "props": [], "methods": [ + { + "name": "start", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." + }, { "name": "center", "parameters": [], @@ -23816,14 +23816,14 @@ "parameters": [], "returnType": "VNode[]", "description": "Custom end template." - }, - { - "name": "start", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom start template." } ] + }, + "ToolbarEmits": { + "description": "Defines valid emits in Toolbar component.", + "relatedProp": "", + "props": [], + "methods": [] } } }, @@ -23844,88 +23844,17 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "TooltipDirectiveBinding": { - "description": "Binding of Tooltip directive.", - "relatedProp": "", - "props": [ - { - "name": "modifiers", - "optional": true, - "readonly": false, - "type": "TooltipDirectiveModifiers", - "default": "", - "description": "Modifiers of the tooltip." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "string | TooltipOptions", - "default": "", - "description": "Value of the tooltip." - } - ], - "methods": [], - "extendedTypes": "Omit" - }, - "TooltipDirectiveModifiers": { - "description": "Defines modifiers of Tooltip.", - "relatedProp": "", - "props": [ - { - "name": "bottom", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Bottom position for Tooltip." - }, - { - "name": "focus", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Focus event for Tooltip." - }, - { - "name": "left", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Left position for Tooltip." - }, - { - "name": "right", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Right position for Tooltip." - }, - { - "name": "top", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Top position for Tooltip." - } - ], - "methods": [] - }, "TooltipOptions": { "description": "Defines options of Tooltip.", "relatedProp": "", "props": [ { - "name": "class", + "name": "value", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "When present, it adds a custom class to the tooltip." + "description": "Text of the tooltip." }, { "name": "disabled", @@ -23935,6 +23864,22 @@ "default": "false", "description": "When present, it specifies that the component should be disabled." }, + { + "name": "id", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "When present, it adds a custom id to the tooltip." + }, + { + "name": "class", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "When present, it adds a custom class to the tooltip." + }, { "name": "escape", "optional": true, @@ -23950,25 +23895,80 @@ "type": "boolean", "default": "true", "description": "Automatically adjusts the element position when there is not enough space on the selected position." - }, + } + ], + "methods": [] + }, + "TooltipDirectiveModifiers": { + "description": "Defines modifiers of Tooltip.", + "relatedProp": "", + "props": [ { - "name": "id", + "name": "right", "optional": true, "readonly": false, - "type": "string", - "default": "", - "description": "When present, it adds a custom id to the tooltip." + "type": "boolean", + "default": "true", + "description": "Right position for Tooltip." }, + { + "name": "left", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Left position for Tooltip." + }, + { + "name": "top", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Top position for Tooltip." + }, + { + "name": "bottom", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Bottom position for Tooltip." + }, + { + "name": "focus", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Focus event for Tooltip." + } + ], + "methods": [] + }, + "TooltipDirectiveBinding": { + "description": "Binding of Tooltip directive.", + "relatedProp": "", + "props": [ { "name": "value", "optional": true, "readonly": false, - "type": "string", + "type": "string | TooltipOptions", "default": "", - "description": "Text of the tooltip." + "description": "Value of the tooltip." + }, + { + "name": "modifiers", + "optional": true, + "readonly": false, + "type": "TooltipDirectiveModifiers", + "default": "", + "description": "Modifiers of the tooltip." } ], - "methods": [] + "methods": [], + "extendedTypes": "Omit" } } } @@ -23990,63 +23990,286 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "TreeNode": { + "description": "Custom TreeNode metadata.", + "relatedProp": "", + "props": [ + { + "name": "key", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Mandatory unique key of the node." + }, + { + "name": "label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Label of the node." + }, + { + "name": "data", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Data represented by the node." + }, + { + "name": "type", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Type of the node to match a template." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Icon of the node to display next to content." + }, + { + "name": "children", + "optional": true, + "readonly": false, + "type": "TreeNode[]", + "default": "", + "description": "An array of treenodes as children." + }, + { + "name": "style", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the node." + }, + { + "name": "styleClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Style class of the node." + }, + { + "name": "selectable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the node is selectable when selection mode is enabled." + }, + { + "name": "leaf", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Specifies if the node has children. Used in lazy loading." + }, + { + "name": "expandedIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Icon to use in expanded state." + }, + { + "name": "collapsedIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Icon to use in collapsed state." + }, + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "TreeExpandedKeys": { + "description": "Custom expanded keys metadata.", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "TreeSelectionKeys": { + "description": "Custom selection keys metadata.", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "TreeProps": { + "description": "Defines valid properties in Tree component.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "TreeNode[]", + "default": "", + "description": "An array of treenodes." + }, + { + "name": "expandedKeys", + "optional": true, + "readonly": false, + "type": "TreeExpandedKeys", + "default": "", + "description": "A map of keys to represent the expansion state in controlled mode." + }, + { + "name": "selectionKeys", + "optional": true, + "readonly": false, + "type": "TreeSelectionKeys", + "default": "", + "description": "A map of keys to control the selection state." + }, + { + "name": "selectionMode", + "optional": true, + "readonly": false, + "type": "\"multiple\" | \"checkbox\" | \"single\"", + "default": "", + "description": "Defines the selection mode." + }, + { + "name": "metaKeySelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." + }, + { + "name": "loading", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to display loading indicator." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-spin", + "description": "Icon to display when tree is loading." + }, + { + "name": "filter", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, displays an input field to filter the items." + }, + { + "name": "filterBy", + "optional": true, + "readonly": false, + "type": "string", + "default": "label", + "description": "When filtering is enabled, filterBy decides which field or fields (comma separated) to search against." + }, + { + "name": "filterMode", + "optional": true, + "readonly": false, + "type": "\"strict\" | \"lenient\"", + "default": "lenient", + "description": "Mode for filtering." + }, + { + "name": "filterPlaceholder", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Placeholder text to show when filter input is empty." + }, + { + "name": "filterLocale", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Locale to use in filtering. The default locale is the host environment's current locale." + }, + { + "name": "scrollHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Height of the scroll viewport in fixed units or the 'flex' keyword for a dynamic size." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying menu element." + } + ], + "methods": [] + }, + "TreeSlots": { + "description": "Defines valid slots in Tree component.", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "Function" + } + ], + "methods": [] + }, "TreeEmits": { "description": "Defines valid slots in Tree component.", "relatedProp": "", "props": [], "methods": [ - { - "name": "node-collapse", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "TreeNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is collapsed." - }, - { - "name": "node-expand", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "TreeNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is expanded." - }, - { - "name": "node-select", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "TreeNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is selected." - }, - { - "name": "node-unselect", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "TreeNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is unselected." - }, { "name": "update:expandedKeys", "parameters": [ @@ -24071,365 +24294,6 @@ ], "returnType": "void", "description": "Emitted when the selection keys change." - } - ] - }, - "TreeExpandedKeys": { - "description": "Custom expanded keys metadata.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, - "TreeNode": { - "description": "Custom TreeNode metadata.", - "relatedProp": "", - "props": [ - { - "name": "children", - "optional": true, - "readonly": false, - "type": "TreeNode[]", - "default": "", - "description": "An array of treenodes as children." - }, - { - "name": "collapsedIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Icon to use in collapsed state." - }, - { - "name": "data", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Data represented by the node." - }, - { - "name": "expandedIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Icon to use in expanded state." - }, - { - "name": "icon", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Icon of the node to display next to content." - }, - { - "name": "key", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Mandatory unique key of the node." - }, - { - "name": "label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Label of the node." - }, - { - "name": "leaf", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Specifies if the node has children. Used in lazy loading." - }, - { - "name": "selectable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the node is selectable when selection mode is enabled." - }, - { - "name": "style", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the node." - }, - { - "name": "styleClass", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Style class of the node." - }, - { - "name": "type", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Type of the node to match a template." - }, - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, - "TreeProps": { - "description": "Defines valid properties in Tree component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Defines a string value that labels an interactive element." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying menu element." - }, - { - "name": "expandedKeys", - "optional": true, - "readonly": false, - "type": "TreeExpandedKeys", - "default": "", - "description": "A map of keys to represent the expansion state in controlled mode." - }, - { - "name": "filter", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, displays an input field to filter the items." - }, - { - "name": "filterBy", - "optional": true, - "readonly": false, - "type": "string", - "default": "label", - "description": "When filtering is enabled, filterBy decides which field or fields (comma separated) to search against." - }, - { - "name": "filterLocale", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Locale to use in filtering. The default locale is the host environment's current locale." - }, - { - "name": "filterMode", - "optional": true, - "readonly": false, - "type": "\"strict\" | \"lenient\"", - "default": "lenient", - "description": "Mode for filtering." - }, - { - "name": "filterPlaceholder", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Placeholder text to show when filter input is empty." - }, - { - "name": "loading", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to display loading indicator." - }, - { - "name": "loadingIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-spin", - "description": "Icon to display when tree is loading." - }, - { - "name": "metaKeySelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." - }, - { - "name": "scrollHeight", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Height of the scroll viewport in fixed units or the 'flex' keyword for a dynamic size." - }, - { - "name": "selectionKeys", - "optional": true, - "readonly": false, - "type": "TreeSelectionKeys", - "default": "", - "description": "A map of keys to control the selection state." - }, - { - "name": "selectionMode", - "optional": true, - "readonly": false, - "type": "\"multiple\" | \"checkbox\" | \"single\"", - "default": "", - "description": "Defines the selection mode." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "TreeNode[]", - "default": "", - "description": "An array of treenodes." - } - ], - "methods": [] - }, - "TreeSelectionKeys": { - "description": "Custom selection keys metadata.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, - "TreeSlots": { - "description": "Defines valid slots in Tree component.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "Function" - } - ], - "methods": [] - } - } - } - }, - "treeselect": { - "description": "TreeSelect is a form component to choose from hierarchical data.\n\n[Live Demo](https://www.primevue.org/treeselect/)", - "components": { - "default": { - "description": "TreeSelect is a form component to choose from hierarchical data.", - "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": { - "TreeSelectEmits": { - "description": "Defines valid emits in TreeSelect component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "before-hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is hidden." - }, - { - "name": "before-show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke before the overlay is shown." - }, - { - "name": "change", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "string[]", - "description": "Selected node keys" - } - ], - "returnType": "void", - "description": "Callback to invoke on value change." - }, - { - "name": "hide", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is hidden." - }, - { - "name": "node-collapse", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "TreeNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is collapsed." - }, - { - "name": "node-expand", - "parameters": [ - { - "name": "node", - "optional": false, - "type": "TreeNode", - "description": "Node instance." - } - ], - "returnType": "void", - "description": "Callback to invoke when a node is expanded." }, { "name": "node-select", @@ -24458,118 +24322,57 @@ "description": "Callback to invoke when a node is unselected." }, { - "name": "show", - "parameters": [], - "returnType": "void", - "description": "Callback to invoke when the overlay is shown." - }, - { - "name": "update:modelValue", + "name": "node-expand", "parameters": [ { - "name": "value", + "name": "node", "optional": false, - "type": "any", - "description": "New value." + "type": "TreeNode", + "description": "Node instance." } ], "returnType": "void", - "description": "Emitted when the value changes." + "description": "Callback to invoke when a node is expanded." + }, + { + "name": "node-collapse", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "TreeNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is collapsed." } ] - }, + } + } + } + }, + "treeselect": { + "description": "TreeSelect is a form component to choose from hierarchical data.\n\n[Live Demo](https://www.primevue.org/treeselect/)", + "components": { + "default": { + "description": "TreeSelect is a form component to choose from hierarchical data.", + "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": { "TreeSelectProps": { "description": "Defines valid properties in TreeSelect component.", "relatedProp": "", "props": [ - { - "name": "appendTo", - "optional": true, - "readonly": false, - "type": "string | HTMLElement", - "default": "body", - "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." - }, - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "display", - "optional": true, - "readonly": false, - "type": "\"comma\" | \"chip\"", - "default": "comma", - "description": "Defines how the selected items are displayed." - }, - { - "name": "emptyMessage", - "optional": true, - "readonly": false, - "type": "string", - "default": "No results found", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." - }, - { - "name": "inputClass", - "optional": true, - "readonly": false, - "type": "string | object", - "default": "", - "description": "Style class of the input field." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "inputStyle", - "optional": true, - "readonly": false, - "type": "object", - "default": "", - "description": "Inline style of the input field." - }, - { - "name": "metaKeySelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." - }, { "name": "modelValue", "optional": true, @@ -24587,12 +24390,12 @@ "description": "An array of treenodes." }, { - "name": "panelClass", + "name": "scrollHeight", "optional": true, "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the overlay panel." + "type": "string", + "default": "200px", + "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." }, { "name": "placeholder", @@ -24603,12 +24406,20 @@ "description": "Label to display when there are no selections." }, { - "name": "scrollHeight", + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "tabindex", "optional": true, "readonly": false, "type": "string", - "default": "200px", - "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." + "default": "", + "description": "Index of the element in tabbing order." }, { "name": "selectionMode", @@ -24619,12 +24430,92 @@ "description": "Defines the selection mode." }, { - "name": "tabindex", + "name": "panelClass", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the overlay panel." + }, + { + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." + }, + { + "name": "emptyMessage", + "optional": true, + "readonly": false, + "type": "string", + "default": "No results found", + "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." + }, + { + "name": "display", + "optional": true, + "readonly": false, + "type": "\"comma\" | \"chip\"", + "default": "comma", + "description": "Defines how the selected items are displayed." + }, + { + "name": "metaKeySelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." + }, + { + "name": "inputId", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Index of the element in tabbing order." + "description": "Identifier of the underlying input element." + }, + { + "name": "inputClass", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Style class of the input field." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "object", + "default": "", + "description": "Inline style of the input field." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." } ], "methods": [] @@ -24635,23 +24526,17 @@ "props": [], "methods": [ { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template." - }, - { - "name": "footer", + "name": "value", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }", - "description": "footer slot's params." + "type": "{\n \t value: any, // Selected value\n \t placeholder: string, // Placeholder\n }", + "description": "value slot's params." } ], "returnType": "VNode[]", - "description": "Custom footer template." + "description": "Custom value template." }, { "name": "header", @@ -24659,7 +24544,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }", + "type": "{\n \t value: any, // Selected value\n \t options: TreeNode, // An array of treenodes.\n }", "description": "header slot's params." } ], @@ -24667,23 +24552,138 @@ "description": "Custom header template." }, { - "name": "indicator", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom indicator template." - }, - { - "name": "value", + "name": "footer", "parameters": [ { "name": "scope", "optional": false, - "type": "{\n \t placeholder: string, // Placeholder\n \t value: any, // Selected value\n }", - "description": "value slot's params." + "type": "{\n \t value: any, // Selected value\n \t options: TreeNode, // An array of treenodes.\n }", + "description": "footer slot's params." } ], "returnType": "VNode[]", - "description": "Custom value template." + "description": "Custom footer template." + }, + { + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." + }, + { + "name": "indicator", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." + } + ] + }, + "TreeSelectEmits": { + "description": "Defines valid emits in TreeSelect component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string[]", + "description": "Selected node keys" + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "before-show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is shown." + }, + { + "name": "before-hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke before the overlay is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is shown." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Callback to invoke when the overlay is hidden." + }, + { + "name": "node-select", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "TreeNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is selected." + }, + { + "name": "node-unselect", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "TreeNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is unselected." + }, + { + "name": "node-expand", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "TreeNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is expanded." + }, + { + "name": "node-collapse", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "TreeNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is collapsed." } ] } @@ -24707,88 +24707,796 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "TreeTableFilterMetaData": { + "description": "Custom treetable filter metadata.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Filter value" + }, + { + "name": "matchMode", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Filter match mode" + } + ], + "methods": [] + }, + "TreeTableOperatorFilterMetaData": { + "description": "Custom operator filter metadata.", + "relatedProp": "", + "props": [ + { + "name": "operator", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Filter operator" + }, + { + "name": "constraints", + "optional": false, + "readonly": false, + "type": "TreeTableFilterMetaData[]", + "default": "", + "description": "Array of filter meta datas." + } + ], + "methods": [] + }, + "TreeTableFilterMeta": { + "description": "Custom filter metadata.", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "string | TreeTableFilterMetaData | TreeTableOperatorFilterMetaData" + } + ], + "methods": [] + }, + "TreeTableSortEvent": { + "description": "Custom sort event.", + "relatedProp": "TreeTableEmits.sort", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "undefined | string | Function", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | null | TreeTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "TreeTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "filterMatchModes", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Match modes per field" + } + ], + "methods": [], + "extendedBy": "TreeTablePageEvent,TreeTableFilterEvent" + }, + "TreeTablePageEvent": { + "description": "Custom page event.", + "relatedProp": "TreeTableEmits.sort", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "undefined | string | Function", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | null | TreeTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "TreeTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "filterMatchModes", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Match modes per field" + }, + { + "name": "page", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "New page number" + }, + { + "name": "pageCount", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Total page count" + } + ], + "methods": [], + "extendedTypes": "TreeTableSortEvent" + }, + "TreeTableFilterEvent": { + "description": "Custom filter event.", + "relatedProp": "TreeTableEmits.sort", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "undefined | string | Function", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | null | TreeTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "TreeTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "filterMatchModes", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "", + "description": "Match modes per field" + }, + { + "name": "filteredValue", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Filtered collection (non-lazy only)" + } + ], + "methods": [], + "extendedTypes": "TreeTableSortEvent" + }, + "TreeTableSortMeta": { + "description": "Custom sort metadata.", + "relatedProp": "", + "props": [ + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Column field" + }, + { + "name": "order", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Column sort order" + } + ], + "methods": [] + }, + "TreeTableExpandedKeys": { + "description": "Custom expanded keys metadata.", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "TreeTableSelectionKeys": { + "description": "Custom selection keys metadata.", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "TreeTableProps": { + "description": "Defines valid properties in TreeTable component.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "TreeNode[]", + "default": "", + "description": "An array of treenodes." + }, + { + "name": "expandedKeys", + "optional": true, + "readonly": false, + "type": "TreeTableExpandedKeys", + "default": "", + "description": "A map of keys to represent the state of the tree expansion state in controlled mode." + }, + { + "name": "selectionKeys", + "optional": true, + "readonly": false, + "type": "TreeTableSelectionKeys", + "default": "", + "description": "A map of keys to control the selection state." + }, + { + "name": "selectionMode", + "optional": true, + "readonly": false, + "type": "\"multiple\" | \"checkbox\" | \"single\"", + "default": "", + "description": "Defines the selection mode." + }, + { + "name": "metaKeySelection", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." + }, + { + "name": "rows", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display per page." + }, + { + "name": "first", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Index of the first row to be displayed." + }, + { + "name": "totalRecords", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of total records, defaults to length of value when not defined." + }, + { + "name": "paginator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified as true, enables the pagination." + }, + { + "name": "paginatorPosition", + "optional": true, + "readonly": false, + "type": "\"both\" | \"top\" | \"bottom\"", + "default": "bottom", + "description": "Position of the paginator, options are 'top','bottom' or 'both'." + }, + { + "name": "alwaysShowPaginator", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Whether to show it even there is only one page." + }, + { + "name": "paginatorTemplate", + "optional": true, + "readonly": false, + "type": "string", + "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", + "description": "Template of the paginator. It can be customized using the template property using the predefined keys. Here are the available elements that can be placed inside a paginator in any order.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" + }, + { + "name": "pageLinkSize", + "optional": true, + "readonly": false, + "type": "number", + "default": "5", + "description": "Number of page links to display." + }, + { + "name": "rowsPerPageOptions", + "optional": true, + "readonly": false, + "type": "number[]", + "default": "", + "description": "Array of integer values to display inside rows per page dropdown." + }, + { + "name": "currentPageReportTemplate", + "optional": true, + "readonly": false, + "type": "string", + "default": "'({currentPage} of {totalPages})'", + "description": "Template of the current page report element. It displays information about the pagination state.\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" + }, + { + "name": "lazy", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if data is loaded and interacted with in lazy manner." + }, + { + "name": "loading", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Displays a loader to indicate data load is in progress." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "string", + "default": "pi pi-spinner", + "description": "The icon to show while indicating data load is in progress." + }, + { + "name": "rowHover", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, background of the rows change on hover." + }, + { + "name": "autoLayout", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether the cell widths scale according to their content or not." + }, + { + "name": "sortField", + "optional": true, + "readonly": false, + "type": "string | Function", + "default": "", + "description": "Property name or a getter function of a row data used for sorting by default." + }, + { + "name": "sortOrder", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Order to sort the data by default." + }, + { + "name": "defaultSortOrder", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Default sort order of an unsorted column." + }, + { + "name": "multiSortMeta", + "optional": true, + "readonly": false, + "type": "null | TreeTableSortMeta[]", + "default": "", + "description": "An array of SortMeta objects to sort the data by default in multiple sort mode." + }, + { + "name": "sortMode", + "optional": true, + "readonly": false, + "type": "\"multiple\" | \"single\"", + "default": "single", + "description": "Defines whether sorting works on single column or on multiple columns." + }, + { + "name": "removableSort", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, columns can have an un-sorted state." + }, + { + "name": "filters", + "optional": true, + "readonly": false, + "type": "TreeTableFilterMeta", + "default": "", + "description": "Filters object with key-value pairs to define the filters." + }, + { + "name": "filterMode", + "optional": true, + "readonly": false, + "type": "\"strict\" | \"lenient\"", + "default": "lenient", + "description": "Mode for filtering." + }, + { + "name": "filterLocale", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Locale to use in filtering. The default locale is the host environment's current locale." + }, + { + "name": "resizableColumns", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, columns can be resized using drag and drop." + }, + { + "name": "columnResizeMode", + "optional": true, + "readonly": false, + "type": "\"fit\" | \"expand\"", + "default": "fit", + "description": "Defines whether the overall table width should change on column resize." + }, + { + "name": "indentation", + "optional": true, + "readonly": false, + "type": "number", + "default": "1", + "description": "Indentation factor as rem value for children nodes." + }, + { + "name": "showGridlines", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to show grid lines between cells." + }, + { + "name": "scrollable", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When specified, enables horizontal and/or vertical scrolling." + }, + { + "name": "scrollHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Height of the scroll viewport in fixed pixels or the 'flex' keyword for a dynamic size." + }, + { + "name": "scrollDirection", + "optional": true, + "readonly": false, + "type": "\"both\" | \"horizontal\" | \"vertical\"", + "default": "vertical", + "description": "Orientation of the scrolling." + }, + { + "name": "responsiveLayout", + "optional": true, + "readonly": false, + "type": "\"scroll\" | \"stack\"", + "default": "stack", + "description": "Defines the responsive mode, currently only option is scroll." + }, + { + "name": "tableProps", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Props to pass to the table element." + } + ], + "methods": [] + }, + "TreeTableSlots": { + "description": "Defines valid slots in TreeTable component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "header", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." + }, + { + "name": "footer", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." + }, + { + "name": "paginatorstart", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator start template." + }, + { + "name": "paginatorend", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator end template." + }, + { + "name": "empty", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." + } + ] + }, "TreeTableEmits": { "description": "Defines valid emits in TreeTable component.", "relatedProp": "", "props": [], "methods": [ { - "name": "column-resize-end", + "name": "update:expandedKeys", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "TreeTableExpandedKeys", + "description": "New expanded keys." + } + ], + "returnType": "void", + "description": "Emitted when the expanded keys change." + }, + { + "name": "update:selectionKeys", "parameters": [ { "name": "event", "optional": false, - "type": "Event", - "description": "Browser event." + "type": "TreeTableSelectionKeys" } ], "returnType": "void", - "description": "Callback to invoke when a column is resized." + "description": "Emitted when the selection keys change." }, { - "name": "filter", + "name": "update:first", "parameters": [ { - "name": "event", + "name": "value", "optional": false, - "type": "TreeTableFilterEvent", - "description": "Custom filter event." + "type": "number", + "description": "New value." } ], "returnType": "void", - "description": "Event to emit after filtering, not triggered in lazy mode." + "description": "Emitted when the first changes." }, { - "name": "node-collapse", + "name": "update:rows", "parameters": [ { - "name": "node", + "name": "value", "optional": false, - "type": "TreeNode", - "description": "Node instance." + "type": "number", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when a node is collapsed." + "description": "Emitted when the rows changes." }, { - "name": "node-expand", + "name": "update:sortField", "parameters": [ { - "name": "node", + "name": "value", "optional": false, - "type": "TreeNode", - "description": "Node instance." + "type": "string", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when a node is expanded." + "description": "Emitted when the sortField changes." }, { - "name": "node-select", + "name": "update:sortOrder", "parameters": [ { - "name": "node", + "name": "value", "optional": false, - "type": "TreeNode", - "description": "Node instance." + "type": "undefined | number", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when a node is selected." + "description": "Emitted when the sortOrder changes." }, { - "name": "node-unselect", + "name": "update:multiSortMeta", "parameters": [ { - "name": "node", + "name": "value", "optional": false, - "type": "TreeNode", - "description": "Node instance." + "type": "undefined | null | TreeTableSortMeta[]", + "description": "New value." } ], "returnType": "void", - "description": "Callback to invoke when a node is unselected." + "description": "Emitted when the multiSortMeta changes." }, { "name": "page", @@ -24817,792 +25525,84 @@ "description": "Callback to invoke on sort. Page and Filter information is also available for lazy loading implementation." }, { - "name": "update:expandedKeys", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "TreeTableExpandedKeys", - "description": "New expanded keys." - } - ], - "returnType": "void", - "description": "Emitted when the expanded keys change." - }, - { - "name": "update:first", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the first changes." - }, - { - "name": "update:multiSortMeta", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "undefined | null | TreeTableSortMeta[]", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the multiSortMeta changes." - }, - { - "name": "update:rows", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number", - "description": "New value." - } - ], - "returnType": "void", - "description": "Emitted when the rows changes." - }, - { - "name": "update:selectionKeys", + "name": "filter", "parameters": [ { "name": "event", "optional": false, - "type": "TreeTableSelectionKeys" + "type": "TreeTableFilterEvent", + "description": "Custom filter event." } ], "returnType": "void", - "description": "Emitted when the selection keys change." + "description": "Event to emit after filtering, not triggered in lazy mode." }, { - "name": "update:sortField", + "name": "node-select", "parameters": [ { - "name": "value", + "name": "node", "optional": false, - "type": "string", - "description": "New value." + "type": "TreeNode", + "description": "Node instance." } ], "returnType": "void", - "description": "Emitted when the sortField changes." + "description": "Callback to invoke when a node is selected." }, { - "name": "update:sortOrder", + "name": "node-unselect", "parameters": [ { - "name": "value", + "name": "node", "optional": false, - "type": "undefined | number", - "description": "New value." + "type": "TreeNode", + "description": "Node instance." } ], "returnType": "void", - "description": "Emitted when the sortOrder changes." + "description": "Callback to invoke when a node is unselected." + }, + { + "name": "node-expand", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "TreeNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is expanded." + }, + { + "name": "node-collapse", + "parameters": [ + { + "name": "node", + "optional": false, + "type": "TreeNode", + "description": "Node instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when a node is collapsed." + }, + { + "name": "column-resize-end", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a column is resized." } ] - }, - "TreeTableExpandedKeys": { - "description": "Custom expanded keys metadata.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, - "TreeTableFilterEvent": { - "description": "Custom filter event.", - "relatedProp": "TreeTableEmits.sort", - "props": [ - { - "name": "filterMatchModes", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Match modes per field" - }, - { - "name": "filteredValue", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Filtered collection (non-lazy only)" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "TreeTableFilterMeta", - "default": "", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | null | TreeTableSortMeta[]", - "default": "", - "description": "MultiSort metadata" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "undefined | string | Function", - "default": "", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Sort order as integer" - } - ], - "methods": [], - "extendedTypes": "TreeTableSortEvent" - }, - "TreeTableFilterMeta": { - "description": "Custom filter metadata.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "string | TreeTableFilterMetaData | TreeTableOperatorFilterMetaData" - } - ], - "methods": [] - }, - "TreeTableFilterMetaData": { - "description": "Custom treetable filter metadata.", - "relatedProp": "", - "props": [ - { - "name": "matchMode", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Filter match mode" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any", - "default": "", - "description": "Filter value" - } - ], - "methods": [] - }, - "TreeTableOperatorFilterMetaData": { - "description": "Custom operator filter metadata.", - "relatedProp": "", - "props": [ - { - "name": "constraints", - "optional": false, - "readonly": false, - "type": "TreeTableFilterMetaData[]", - "default": "", - "description": "Array of filter meta datas." - }, - { - "name": "operator", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Filter operator" - } - ], - "methods": [] - }, - "TreeTablePageEvent": { - "description": "Custom page event.", - "relatedProp": "TreeTableEmits.sort", - "props": [ - { - "name": "filterMatchModes", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Match modes per field" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "TreeTableFilterMeta", - "default": "", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | null | TreeTableSortMeta[]", - "default": "", - "description": "MultiSort metadata" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - }, - { - "name": "page", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "New page number" - }, - { - "name": "pageCount", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Total page count" - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "undefined | string | Function", - "default": "", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Sort order as integer" - } - ], - "methods": [], - "extendedTypes": "TreeTableSortEvent" - }, - "TreeTableProps": { - "description": "Defines valid properties in TreeTable component.", - "relatedProp": "", - "props": [ - { - "name": "alwaysShowPaginator", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Whether to show it even there is only one page." - }, - { - "name": "autoLayout", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether the cell widths scale according to their content or not." - }, - { - "name": "columnResizeMode", - "optional": true, - "readonly": false, - "type": "\"fit\" | \"expand\"", - "default": "fit", - "description": "Defines whether the overall table width should change on column resize." - }, - { - "name": "currentPageReportTemplate", - "optional": true, - "readonly": false, - "type": "string", - "default": "'({currentPage} of {totalPages})'", - "description": "Template of the current page report element. It displays information about the pagination state.\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" - }, - { - "name": "defaultSortOrder", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Default sort order of an unsorted column." - }, - { - "name": "expandedKeys", - "optional": true, - "readonly": false, - "type": "TreeTableExpandedKeys", - "default": "", - "description": "A map of keys to represent the state of the tree expansion state in controlled mode." - }, - { - "name": "filterLocale", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Locale to use in filtering. The default locale is the host environment's current locale." - }, - { - "name": "filterMode", - "optional": true, - "readonly": false, - "type": "\"strict\" | \"lenient\"", - "default": "lenient", - "description": "Mode for filtering." - }, - { - "name": "filters", - "optional": true, - "readonly": false, - "type": "TreeTableFilterMeta", - "default": "", - "description": "Filters object with key-value pairs to define the filters." - }, - { - "name": "first", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Index of the first row to be displayed." - }, - { - "name": "indentation", - "optional": true, - "readonly": false, - "type": "number", - "default": "1", - "description": "Indentation factor as rem value for children nodes." - }, - { - "name": "lazy", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if data is loaded and interacted with in lazy manner." - }, - { - "name": "loading", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Displays a loader to indicate data load is in progress." - }, - { - "name": "loadingIcon", - "optional": true, - "readonly": false, - "type": "string", - "default": "pi pi-spinner", - "description": "The icon to show while indicating data load is in progress." - }, - { - "name": "metaKeySelection", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually.\nOn touch enabled devices, metaKeySelection is turned off automatically." - }, - { - "name": "multiSortMeta", - "optional": true, - "readonly": false, - "type": "null | TreeTableSortMeta[]", - "default": "", - "description": "An array of SortMeta objects to sort the data by default in multiple sort mode." - }, - { - "name": "pageLinkSize", - "optional": true, - "readonly": false, - "type": "number", - "default": "5", - "description": "Number of page links to display." - }, - { - "name": "paginator", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified as true, enables the pagination." - }, - { - "name": "paginatorPosition", - "optional": true, - "readonly": false, - "type": "\"both\" | \"top\" | \"bottom\"", - "default": "bottom", - "description": "Position of the paginator, options are 'top','bottom' or 'both'." - }, - { - "name": "paginatorTemplate", - "optional": true, - "readonly": false, - "type": "string", - "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", - "description": "Template of the paginator. It can be customized using the template property using the predefined keys. Here are the available elements that can be placed inside a paginator in any order.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" - }, - { - "name": "removableSort", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, columns can have an un-sorted state." - }, - { - "name": "resizableColumns", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, columns can be resized using drag and drop." - }, - { - "name": "responsiveLayout", - "optional": true, - "readonly": false, - "type": "\"scroll\" | \"stack\"", - "default": "stack", - "description": "Defines the responsive mode, currently only option is scroll." - }, - { - "name": "rowHover", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, background of the rows change on hover." - }, - { - "name": "rows", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display per page." - }, - { - "name": "rowsPerPageOptions", - "optional": true, - "readonly": false, - "type": "number[]", - "default": "", - "description": "Array of integer values to display inside rows per page dropdown." - }, - { - "name": "scrollDirection", - "optional": true, - "readonly": false, - "type": "\"both\" | \"horizontal\" | \"vertical\"", - "default": "vertical", - "description": "Orientation of the scrolling." - }, - { - "name": "scrollHeight", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Height of the scroll viewport in fixed pixels or the 'flex' keyword for a dynamic size." - }, - { - "name": "scrollable", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When specified, enables horizontal and/or vertical scrolling." - }, - { - "name": "selectionKeys", - "optional": true, - "readonly": false, - "type": "TreeTableSelectionKeys", - "default": "", - "description": "A map of keys to control the selection state." - }, - { - "name": "selectionMode", - "optional": true, - "readonly": false, - "type": "\"multiple\" | \"checkbox\" | \"single\"", - "default": "", - "description": "Defines the selection mode." - }, - { - "name": "showGridlines", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to show grid lines between cells." - }, - { - "name": "sortField", - "optional": true, - "readonly": false, - "type": "string | Function", - "default": "", - "description": "Property name or a getter function of a row data used for sorting by default." - }, - { - "name": "sortMode", - "optional": true, - "readonly": false, - "type": "\"multiple\" | \"single\"", - "default": "single", - "description": "Defines whether sorting works on single column or on multiple columns." - }, - { - "name": "sortOrder", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Order to sort the data by default." - }, - { - "name": "tableProps", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Props to pass to the table element." - }, - { - "name": "totalRecords", - "optional": true, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of total records, defaults to length of value when not defined." - }, - { - "name": "value", - "optional": true, - "readonly": false, - "type": "TreeNode[]", - "default": "", - "description": "An array of treenodes." - } - ], - "methods": [] - }, - "TreeTableSelectionKeys": { - "description": "Custom selection keys metadata.", - "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" - } - ], - "methods": [] - }, - "TreeTableSlots": { - "description": "Defines valid slots in TreeTable component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "empty", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom empty template." - }, - { - "name": "footer", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom footer template." - }, - { - "name": "header", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom header template." - }, - { - "name": "paginatorend", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom paginator end template." - }, - { - "name": "paginatorstart", - "parameters": [], - "returnType": "VNode[]", - "description": "Custom paginator start template." - } - ] - }, - "TreeTableSortEvent": { - "description": "Custom sort event.", - "relatedProp": "TreeTableEmits.sort", - "props": [ - { - "name": "filterMatchModes", - "optional": false, - "readonly": false, - "type": "undefined | string", - "default": "", - "description": "Match modes per field" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "TreeTableFilterMeta", - "default": "", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | null | TreeTableSortMeta[]", - "default": "", - "description": "MultiSort metadata" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "default": "", - "description": "Browser event." - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Number of rows to display in new page" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "undefined | string | Function", - "default": "", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Sort order as integer" - } - ], - "methods": [], - "extendedBy": "TreeTablePageEvent,TreeTableFilterEvent" - }, - "TreeTableSortMeta": { - "description": "Custom sort metadata.", - "relatedProp": "", - "props": [ - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "default": "", - "description": "Column field" - }, - { - "name": "order", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "default": "", - "description": "Column sort order" - } - ], - "methods": [] } } } @@ -25624,6 +25624,75 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "TriStateCheckboxProps": { + "description": "Defines valid properties in TriStateCheckbox component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "Nullable", + "default": "null", + "description": "Value of the component." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Index of the element in tabbing order." + }, + { + "name": "inputId", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, + { + "name": "inputProps", + "optional": true, + "readonly": false, + "type": "InputHTMLAttributes", + "default": "", + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + "name": "aria-labelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + "name": "aria-label", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Establishes a string value that labels the component." + } + ], + "methods": [] + }, + "TriStateCheckboxSlots": { + "description": "Defines valid slots in TriStateCheckbox component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "TriStateCheckboxEmits": { "description": "Defines valid emits in TriStateCheckbox component.", "relatedProp": "", @@ -25643,75 +25712,6 @@ "description": "Emitted when the value changes." } ] - }, - "TriStateCheckboxProps": { - "description": "Defines valid properties in TriStateCheckbox component.", - "relatedProp": "", - "props": [ - { - "name": "aria-label", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes a string value that labels the component." - }, - { - "name": "aria-labelledby", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When present, it specifies that the component should be disabled." - }, - { - "name": "inputId", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Identifier of the underlying input element." - }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, - { - "name": "modelValue", - "optional": true, - "readonly": false, - "type": "Nullable", - "default": "null", - "description": "Value of the component." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Index of the element in tabbing order." - } - ], - "methods": [] - }, - "TriStateCheckboxSlots": { - "description": "Defines valid slots in TriStateCheckbox component.", - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -25720,9 +25720,11 @@ "types": { "description": "Defines the custom types used by the module.", "values": { - "Booleanish": { - "values": "boolean | \"true\" | \"false\"", - "description": "Custom types" + "PublicProps": { + "values": "VNodeProps & AllowedComponentProps & ComponentCustomProps" + }, + "UnionToIntersection": { + "values": "(U extends any ? Function : never) extends Function ? I : never" }, "EmitFn": { "values": "Options extends (infer V)[] ? Function : Object extends Options ? Function : UnionToIntersection<{ [key in Event]: Options[key] extends Function ? Function : Function }[Event]>" @@ -25730,17 +25732,15 @@ "GlobalComponentConstructor": { "values": "{}" }, - "Nullable": { - "values": "T | null | undefined" + "Booleanish": { + "values": "boolean | \"true\" | \"false\"", + "description": "Custom types" }, "Numberish": { "values": "number | string" }, - "PublicProps": { - "values": "VNodeProps & AllowedComponentProps & ComponentCustomProps" - }, - "UnionToIntersection": { - "values": "(U extends any ? Function : never) extends Function ? I : never" + "Nullable": { + "values": "T | null | undefined" } } } @@ -25785,11 +25785,6 @@ "functions": { "description": "Defines the custom functions used by the module.", "values": { - "EventBus": { - "name": "EventBus", - "parameters": [], - "returnType": "Object" - }, "UniqueComponentId": { "name": "UniqueComponentId", "parameters": [ @@ -25799,6 +25794,11 @@ } ], "returnType": "string" + }, + "EventBus": { + "name": "EventBus", + "parameters": [], + "returnType": "Object" } } } @@ -25811,34 +25811,6 @@ "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [ - { - "name": "getRenderedRange", - "parameters": [], - "returnType": "VirtualScrollerRangeMethod", - "description": "Returns the range of items added to the DOM." - }, - { - "name": "scrollInView", - "parameters": [ - { - "name": "index", - "type": "number", - "description": "Index of item according to orientation mode." - }, - { - "name": "to", - "type": "\"to-start\" | \"to-end\"", - "description": "Defines the location of the item in view," - }, - { - "name": "behavior", - "type": "ScrollBehavior", - "description": "Behavior of scroll" - } - ], - "returnType": "void", - "description": "It is used to move the specified index into the view. It is a method that will usually be needed when keyboard support is added to the virtualScroller component." - }, { "name": "scrollTo", "parameters": [ @@ -25867,6 +25839,34 @@ ], "returnType": "void", "description": "Scroll to move to a specific item." + }, + { + "name": "scrollInView", + "parameters": [ + { + "name": "index", + "type": "number", + "description": "Index of item according to orientation mode." + }, + { + "name": "to", + "type": "\"to-start\" | \"to-end\"", + "description": "Defines the location of the item in view," + }, + { + "name": "behavior", + "type": "ScrollBehavior", + "description": "Behavior of scroll" + } + ], + "returnType": "void", + "description": "It is used to move the specified index into the view. It is a method that will usually be needed when keyboard support is added to the virtualScroller component." + }, + { + "name": "getRenderedRange", + "parameters": [], + "returnType": "VirtualScrollerRangeMethod", + "description": "Returns the range of items added to the DOM." } ] } @@ -25878,126 +25878,29 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { - "VirtualScrollerEmits": { - "description": "Defines valid emits in VirtualScroller component.", - "relatedProp": "", - "props": [], - "methods": [ - { - "name": "lazy-load", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "VirtualScrollerLazyEvent", - "description": "Custom lazy event." - } - ], - "returnType": "void", - "description": "Callback to invoke in lazy mode to load new data." - }, - { - "name": "scroll", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "Event", - "description": "Browser event." - } - ], - "returnType": "void", - "description": "Callback to invoke when scroll position changes." - }, - { - "name": "scroll-index-change", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "VirtualScrollerScrollIndexChangeEvent", - "description": "Custom tab open event." - } - ], - "returnType": "void", - "description": "Callback to invoke when scroll position and item's range in view changes." - }, - { - "name": "update:numToleratedItems", - "parameters": [ - { - "name": "value", - "optional": false, - "type": "number", - "description": "New number tolerated items" - } - ], - "returnType": "void", - "description": "Emitted when the numToleratedItems changes." - } - ] - }, - "VirtualScrollerItemOptions": { - "description": "Custom item options.", - "relatedProp": "", + "VirtualScrollerScrollIndexChangeEvent": { + "description": "Custom scroll index change event.", + "relatedProp": "VirtualScrollerEmits['scroll-index-change']", "props": [ - { - "name": "count", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Items count" - }, - { - "name": "even", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is even." - }, { "name": "first", "optional": false, "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is first." - }, - { - "name": "index", - "optional": false, - "readonly": false, "type": "number", "default": "", - "description": "Item index" + "description": "First index of the new data range to be loaded." }, { "name": "last", "optional": false, "readonly": false, - "type": "boolean", + "type": "number", "default": "", - "description": "Whether the item is last." - }, - { - "name": "odd", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is odd." - }, - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "any" + "description": "Last index of the new data range to be loaded." } ], "methods": [], - "extendedBy": "VirtualScrollerLoaderOptions" + "extendedBy": "VirtualScrollerLazyEvent,VirtualScrollerViewport" }, "VirtualScrollerLazyEvent": { "description": "Custom lazy event.", @@ -26023,259 +25926,29 @@ "methods": [], "extendedTypes": "VirtualScrollerScrollIndexChangeEvent" }, - "VirtualScrollerLoaderOptions": { - "description": "Custom virtualscroller loader options", - "relatedProp": "undefined.VirtualScrollerItemOptions", + "VirtualScrollerViewport": { + "description": "Custom virtualscroller viewport metadata.", + "relatedProp": "VirtualScrollerEmits['scroll-index-change']", "props": [ - { - "name": "count", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Items count" - }, - { - "name": "even", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is even." - }, { "name": "first", "optional": false, "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is first." - }, - { - "name": "index", - "optional": false, - "readonly": false, "type": "number", "default": "", - "description": "Item index" + "description": "First index of the new data range to be loaded." }, { "name": "last", "optional": false, "readonly": false, - "type": "boolean", + "type": "number", "default": "", - "description": "Whether the item is last." - }, - { - "name": "odd", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether the item is odd." + "description": "Last index of the new data range to be loaded." } ], "methods": [], - "extendedBy": "ColumnLoadingOptions", - "extendedTypes": "VirtualScrollerItemOptions" - }, - "VirtualScrollerProps": { - "description": "Defines valid properties in VirtualScroller component.", - "relatedProp": "", - "props": [ - { - "name": "appendOnly", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Used to append each loaded item to top without removing any items from the DOM. Using very large data may cause the browser to crash." - }, - { - "name": "autoSize", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to dynamically change the height or width of scrollable container." - }, - { - "name": "class", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Style class of the component." - }, - { - "name": "delay", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Delay in scroll before new data is loaded." - }, - { - "name": "disabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "If disabled, the VirtualScroller feature is eliminated and the content is displayed directly." - }, - { - "name": "id", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Unique identifier of the element." - }, - { - "name": "inline", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "When enabled, positions the content as inline." - }, - { - "name": "itemSize", - "optional": true, - "readonly": false, - "type": "number | number[]", - "default": "", - "description": "The height/width of item according to orientation." - }, - { - "name": "items", - "optional": true, - "readonly": false, - "type": "null | any[] | any[][]", - "default": "", - "description": "An array of objects to display." - }, - { - "name": "lazy", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Defines if data is loaded and interacted with in lazy manner." - }, - { - "name": "loaderDisabled", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Used to implement a custom loader instead of using the loader feature in the VirtualScroller." - }, - { - "name": "loading", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Whether to load items." - }, - { - "name": "numToleratedItems", - "optional": true, - "readonly": false, - "type": "number", - "default": "half the number of items shown in the view.", - "description": "Determines how many additional elements to add to the DOM outside of the view.\nAccording to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number." - }, - { - "name": "orientation", - "optional": true, - "readonly": false, - "type": "\"both\" | \"horizontal\" | \"vertical\"", - "default": "vertical", - "description": "The orientation of scrollbar." - }, - { - "name": "resizeDelay", - "optional": true, - "readonly": false, - "type": "number", - "default": "10", - "description": "Delay after window's resize finishes." - }, - { - "name": "scrollHeight", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Height of the scroll viewport." - }, - { - "name": "scrollWidth", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Width of the scroll viewport." - }, - { - "name": "showLoader", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "", - "description": "Whether to show loader." - }, - { - "name": "showSpacer", - "optional": true, - "readonly": false, - "type": "boolean", - "default": "true", - "description": "Used to implement a custom spacer instead of using the spacer feature in the VirtualScroller." - }, - { - "name": "step", - "optional": true, - "readonly": false, - "type": "number", - "default": "0", - "description": "Used to specify how many items to load in each load method in lazy mode." - }, - { - "name": "style", - "optional": true, - "readonly": false, - "type": "any", - "default": "", - "description": "Inline style of the component." - }, - { - "name": "tabindex", - "optional": true, - "readonly": false, - "type": "string | number", - "default": "0", - "description": "Index of the element in tabbing order." - } - ], - "methods": [ - { - "name": "onLazyLoad", - "parameters": [ - { - "name": "event", - "optional": false, - "type": "VirtualScrollerLazyEvent", - "description": "Custom lazy event." - } - ], - "returnType": "void", - "description": "Callback to invoke in lazy mode to load new data." - } - ] + "extendedTypes": "VirtualScrollerScrollIndexChangeEvent" }, "VirtualScrollerRangeMethod": { "description": "Virtual scroller rendered range.", @@ -26308,29 +25981,321 @@ ], "methods": [] }, - "VirtualScrollerScrollIndexChangeEvent": { - "description": "Custom scroll index change event.", - "relatedProp": "VirtualScrollerEmits['scroll-index-change']", + "VirtualScrollerItemOptions": { + "description": "Custom item options.", + "relatedProp": "", "props": [ { - "name": "first", + "name": "index", "optional": false, "readonly": false, "type": "number", "default": "", - "description": "First index of the new data range to be loaded." + "description": "Item index" + }, + { + "name": "count", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Items count" + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is first." }, { "name": "last", "optional": false, "readonly": false, - "type": "number", + "type": "boolean", "default": "", - "description": "Last index of the new data range to be loaded." + "description": "Whether the item is last." + }, + { + "name": "even", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is even." + }, + { + "name": "odd", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is odd." + }, + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" } ], "methods": [], - "extendedBy": "VirtualScrollerLazyEvent,VirtualScrollerViewport" + "extendedBy": "VirtualScrollerLoaderOptions" + }, + "VirtualScrollerLoaderOptions": { + "description": "Custom virtualscroller loader options", + "relatedProp": "undefined.VirtualScrollerItemOptions", + "props": [ + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Item index" + }, + { + "name": "count", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Items count" + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is first." + }, + { + "name": "last", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is last." + }, + { + "name": "even", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is even." + }, + { + "name": "odd", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the item is odd." + } + ], + "methods": [], + "extendedBy": "ColumnLoadingOptions", + "extendedTypes": "VirtualScrollerItemOptions" + }, + "VirtualScrollerProps": { + "description": "Defines valid properties in VirtualScroller component.", + "relatedProp": "", + "props": [ + { + "name": "id", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Unique identifier of the element." + }, + { + "name": "style", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the component." + }, + { + "name": "class", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the component." + }, + { + "name": "items", + "optional": true, + "readonly": false, + "type": "null | any[] | any[][]", + "default": "", + "description": "An array of objects to display." + }, + { + "name": "itemSize", + "optional": true, + "readonly": false, + "type": "number | number[]", + "default": "", + "description": "The height/width of item according to orientation." + }, + { + "name": "scrollHeight", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Height of the scroll viewport." + }, + { + "name": "scrollWidth", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Width of the scroll viewport." + }, + { + "name": "orientation", + "optional": true, + "readonly": false, + "type": "\"both\" | \"horizontal\" | \"vertical\"", + "default": "vertical", + "description": "The orientation of scrollbar." + }, + { + "name": "numToleratedItems", + "optional": true, + "readonly": false, + "type": "number", + "default": "half the number of items shown in the view.", + "description": "Determines how many additional elements to add to the DOM outside of the view.\nAccording to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number." + }, + { + "name": "delay", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Delay in scroll before new data is loaded." + }, + { + "name": "resizeDelay", + "optional": true, + "readonly": false, + "type": "number", + "default": "10", + "description": "Delay after window's resize finishes." + }, + { + "name": "lazy", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Defines if data is loaded and interacted with in lazy manner." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "If disabled, the VirtualScroller feature is eliminated and the content is displayed directly." + }, + { + "name": "loaderDisabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Used to implement a custom loader instead of using the loader feature in the VirtualScroller." + }, + { + "name": "showLoader", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether to show loader." + }, + { + "name": "showSpacer", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Used to implement a custom spacer instead of using the spacer feature in the VirtualScroller." + }, + { + "name": "loading", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to load items." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "string | number", + "default": "0", + "description": "Index of the element in tabbing order." + }, + { + "name": "inline", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, positions the content as inline." + }, + { + "name": "step", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Used to specify how many items to load in each load method in lazy mode." + }, + { + "name": "appendOnly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Used to append each loaded item to top without removing any items from the DOM. Using very large data may cause the browser to crash." + }, + { + "name": "autoSize", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Whether to dynamically change the height or width of scrollable container." + } + ], + "methods": [ + { + "name": "onLazyLoad", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "VirtualScrollerLazyEvent", + "description": "Custom lazy event." + } + ], + "returnType": "void", + "description": "Callback to invoke in lazy mode to load new data." + } + ] }, "VirtualScrollerSlots": { "description": "Defines valid slots in VirtualScroller component.", @@ -26343,7 +26308,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t both: boolean, // Whether the orientation is both.\n \t columns: undefined, // The number of the rendered columns.\n \t contentStyle: any, // The style of content element.\n \t horizontal: boolean, // Whether the orientation is horizontal.\n \t itemSize: undefined, // The height/width of item according to orientation.\n \t items: any, // An array of objects to display for virtualscroller\n \t loading: boolean, // Whether the data is loaded.\n \t rows: undefined, // The number of the rendered rows.\n \t spacerStyle: any, // The style of spacer element.\n \t styleClass: string, // Style class of the content\n \t vertical: boolean, // Whether the orientation is vertical.\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n \t getLoaderOptions(index: number, ext: any): VirtualScrollerLoaderOptions, // Loader options of the items while the data is loading.\n }", + "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the content\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n \t loading: boolean, // Whether the data is loaded.\n \t getLoaderOptions(index: number, ext: any): VirtualScrollerLoaderOptions, // Loader options of the items while the data is loading.\n \t itemSize: undefined, // The height/width of item according to orientation.\n \t rows: undefined, // The number of the rendered rows.\n \t columns: undefined, // The number of the rendered columns.\n \t spacerStyle: any, // The style of spacer element.\n \t contentStyle: any, // The style of content element.\n \t vertical: boolean, // Whether the orientation is vertical.\n \t horizontal: boolean, // Whether the orientation is horizontal.\n \t both: boolean, // Whether the orientation is both.\n }", "description": "content slot's params." } ], @@ -26378,29 +26343,64 @@ } ] }, - "VirtualScrollerViewport": { - "description": "Custom virtualscroller viewport metadata.", - "relatedProp": "VirtualScrollerEmits['scroll-index-change']", - "props": [ + "VirtualScrollerEmits": { + "description": "Defines valid emits in VirtualScroller component.", + "relatedProp": "", + "props": [], + "methods": [ { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "First index of the new data range to be loaded." + "name": "update:numToleratedItems", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New number tolerated items" + } + ], + "returnType": "void", + "description": "Emitted when the numToleratedItems changes." }, { - "name": "last", - "optional": false, - "readonly": false, - "type": "number", - "default": "", - "description": "Last index of the new data range to be loaded." + "name": "scroll", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when scroll position changes." + }, + { + "name": "scroll-index-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "VirtualScrollerScrollIndexChangeEvent", + "description": "Custom tab open event." + } + ], + "returnType": "void", + "description": "Callback to invoke when scroll position and item's range in view changes." + }, + { + "name": "lazy-load", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "VirtualScrollerLazyEvent", + "description": "Custom lazy event." + } + ], + "returnType": "void", + "description": "Callback to invoke in lazy mode to load new data." } - ], - "methods": [], - "extendedTypes": "VirtualScrollerScrollIndexChangeEvent" + ] } } } diff --git a/layouts/doc/helpers/PTHelper.js b/layouts/doc/helpers/PTHelper.js index d21820f1b..bd74beb72 100644 --- a/layouts/doc/helpers/PTHelper.js +++ b/layouts/doc/helpers/PTHelper.js @@ -1,6 +1,6 @@ import APIDocs from '@/doc/common/apidoc/index.json'; -export const getPTOption = name => { +export const getPTOption = (name) => { const { props } = APIDocs[name.toLowerCase()].interfaces.values[`${name}PassThroughOptions`]; let data = [];