From ff4eb169ded66c29f69fa9749399e83c7e10fecf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tu=C4=9F=C3=A7e=20K=C3=BC=C3=A7=C3=BCko=C4=9Flu?= Date: Thu, 2 Mar 2023 21:54:13 +0300 Subject: [PATCH] Update index.json --- doc/common/apidoc/index.json | 9107 +++++++++++++++++++++++++--------- 1 file changed, 6764 insertions(+), 2343 deletions(-) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 4c559adca..381eec593 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -2,7 +2,7 @@ "accordion": { "description": "Accordion groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/accordion/)", "components": { - "Accordion": { + "default": { "description": "Accordion groups a collection of contents in tabs.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -164,6 +164,19 @@ ], "methods": [] }, + "AccordionSlots": { + "description": "Defines valid slots in Accordion slots.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "default", + "parameters": [], + "returnType": "VNode[]", + "description": "Default slot to detect AccordionTab components." + } + ] + }, "AccordionTabCloseEvent": { "description": "Custom tab close event.", "relatedProp": "tab-close", @@ -213,21 +226,12 @@ "extendedBy": "AccordionTabCloseEvent,AccordionClickEvent" } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "AccordionSlots": { - "values": "{}", - "description": "Defines valid slots in Accordion slots." - } - } } }, "accordiontab": { "description": "AccordionTab is a helper component for Accordion.\n\n[Live Demo](https://www.primevue.org/accordion/)", "components": { - "AccordionTab": { + "default": { "description": "AccordionTab is a helper component for Accordion..", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -2346,7 +2350,17 @@ } } }, - "autocomplete/AutoComplete": { + "autocomplete": { + "description": "AutoComplete is an input component that provides real-time suggestions while being typed.\n\n[Live Demo](https://www.primevue.org/autocomplete/)", + "components": { + "default": { + "description": "AutoComplete is an input component that provides real-time suggestions while being typed.", + "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.", @@ -2356,7 +2370,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "AutoCompleteChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -2378,7 +2393,8 @@ "methods": [] }, "AutoCompleteCompleteEvent": { - "relatedProp": "", + "description": "Custom complete event.", + "relatedProp": "complete", "props": [ { "name": "originalEvent", @@ -2400,7 +2416,8 @@ "methods": [] }, "AutoCompleteDropdownClickEvent": { - "relatedProp": "", + "description": "Custom dropdown click event.", + "relatedProp": "['dropdown-click']", "props": [ { "name": "originalEvent", @@ -2421,8 +2438,150 @@ ], "methods": [] }, - "AutoCompleteItemSelectEvent": { + "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": "['item-select']", "props": [ { "name": "originalEvent", @@ -2445,8 +2604,8 @@ "extendedBy": "AutoCompleteItemUnselectEvent" }, "AutoCompleteItemUnselectEvent": { - "description": "", - "relatedProp": "", + "description": "Custom item unselect event.", + "relatedProp": "['item-unselect']", "props": [ { "name": "originalEvent", @@ -2469,14 +2628,15 @@ "extendedTypes": "AutoCompleteItemSelectEvent" }, "AutoCompleteProps": { + "description": "Defines valid properties in AutoComplete component.", "relatedProp": "", "props": [ { "name": "appendTo", "optional": true, "readonly": false, - "type": "AutoCompleteAppendTo", - "default": "", + "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." }, { @@ -2500,7 +2660,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "" }, { @@ -2508,15 +2668,15 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown.\nDefault value is true." + "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": "", + "default": "false", "description": "Whether to run a query when input receives focus." }, { @@ -2532,15 +2692,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Delay between keystrokes to wait before sending a query.\nDefault value is 300." + "default": "300", + "description": "Delay between keystrokes to wait before sending a query." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -2548,7 +2708,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Displays a button next to the input field when enabled." }, { @@ -2564,15 +2724,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dropdown.\nDefault value is 'pi pi-chevron-down'." + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." }, { "name": "dropdownMode", "optional": true, "readonly": false, - "type": "AutoCompleteDropdownMode", - "default": "", + "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." }, { @@ -2580,22 +2740,22 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No selected item'." + "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": "field", "optional": true, "readonly": false, - "type": "AutoCompleteFieldType", + "type": "string | Function", "default": "", "description": "" }, @@ -2604,7 +2764,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "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." }, { @@ -2644,16 +2804,16 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in loading state.\nDefault value is 'pi pi-spinner pi-spin'." + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." }, { "name": "minLength", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Minimum number of characters to initiate a search.\nDefault value is 1." + "default": "1", + "description": "Minimum number of characters to initiate a search." }, { "name": "modelValue", @@ -2668,14 +2828,14 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Specifies if multiple values can be selected." }, { "name": "optionDisabled", "optional": true, "readonly": false, - "type": "AutoCompleteOptionDisabledType", + "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." }, @@ -2683,7 +2843,7 @@ "name": "optionGroupChildren", "optional": true, "readonly": false, - "type": "AutoCompleteOptionChildrenType", + "type": "string | Function", "default": "", "description": "Property name or getter function that refers to the children options of option group." }, @@ -2691,7 +2851,7 @@ "name": "optionGroupLabel", "optional": true, "readonly": false, - "type": "AutoCompleteOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option group." }, @@ -2699,7 +2859,7 @@ "name": "optionLabel", "optional": true, "readonly": false, - "type": "AutoCompleteOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option." }, @@ -2740,16 +2900,16 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in chip remove action.\nDefault value is 'pi pi-times-circle'." + "default": "pi pi-times-circle", + "description": "Icon to display in chip remove action." }, { "name": "scrollHeight", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Maximum height of the suggestions panel.\nDefault value is '200px'." + "default": "200px", + "description": "Maximum height of the suggestions panel." }, { "name": "searchLocale", @@ -2764,24 +2924,24 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} results are available'." + "default": "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": "", - "description": "When enabled, the focused option is selected.\nDefault value is false." + "default": "false", + "description": "When enabled, the focused option is selected." }, { "name": "selectionMessage", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} items selected'." + "default": "items selected", + "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { "name": "suggestions", @@ -2811,86 +2971,136 @@ "methods": [] }, "AutoCompleteSlots": { + "description": "Defines valid slots in AutoComplete component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "chip", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "chip slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom chip template." }, { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "content slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom panel template." }, { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template when there is no data to display." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template of panel." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template of panel." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "" }, { "name": "loader", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "loader slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom loader template." }, { "name": "option", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." }, { "name": "optiongroup", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option group slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option group template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "AutoCompleteEmits": { - "values": "{\n \"before-hide\": \"Function, \",\n \"before-show\": \"Function, \",\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"clear\": \"Function, \",\n \"complete\": \"Function, \",\n \"dropdown-click\": \"Function, \",\n \"focus\": \"Function, \",\n \"hide\": \"Function, \",\n \"item-select\": \"Function, \",\n \"item-unselect\": \"Function, \",\n \"show\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "avatar/Avatar": { + "avatar": { + "description": "Avatar represents people using icons, labels and images.\n\n- [Live Demo](https://primevue.org/avatar)", + "components": { + "default": { + "description": "Avatar represents people using icons, labels and images.", + "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.", @@ -2899,7 +3109,21 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -2946,46 +3170,48 @@ "name": "shape", "optional": true, "readonly": false, - "type": "AvatarShapeType", - "default": "", - "description": "Shape of the element, valid options are 'square' and 'circle'." + "type": "\"square\" | \"circle\"", + "default": "square", + "description": "Shape of the element." }, { "name": "size", "optional": true, "readonly": false, - "type": "AvatarSizeType", - "default": "", - "description": "Size of the element, valid options are 'normal', 'large' and 'xlarge'." + "type": "\"normal\" | \"large\" | \"xlarge\"", + "default": "normal", + "description": "Size of the element." } ], "methods": [] }, "AvatarSlots": { + "description": "Defines valid slots in Avatar component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Content can easily be customized with the default slot instead of using the built-in modes." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "AvatarEmits": { - "values": "{\n \"error\": \"Function, \"\n}" + ] } } } }, - "avatargroup/AvatarGroup": { + "avatargroup": { + "description": "AvatarGroup is a helper component for Avatar.\n\n[Live Demo](https://www.primevue.org/accordion/)", + "components": { + "default": { + "description": "A set of Avatars can be displayed together using the AvatarGroup component.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -2994,28 +3220,38 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "AvatarGroupEmits": { + "description": "Defines valid emits in AvatarGroup component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "AvatarGroupProps": { + "description": "Defines valid properties in AvatarGroup component.", "relatedProp": "", "props": [], "methods": [] }, "AvatarGroupSlots": { + "description": "Defines valid slots in AvatarGroup component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "AvatarGroupEmits": { - "values": "{}" - } - } } }, - "badge/Badge": { + "badge": { + "description": "Badge represents people using icons, labels and images.\n\n[Live Demo](https://www.primevue.org/badge)", + "components": { + "default": { + "description": "Badge represents people using icons, labels and images.", + "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.", @@ -3024,14 +3260,21 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "BadgeEmits": { + "description": "Defines valid emits in Badge component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "BadgeProps": { + "description": "Defines valid properties in Badge component.", "relatedProp": "", "props": [ { "name": "severity", "optional": true, "readonly": false, - "type": "BadgeSeverityType", + "type": "\"success\" | \"info\" | \"warning\" | \"danger\"", "default": "", "description": "Severity type of the badge." }, @@ -3039,7 +3282,7 @@ "name": "size", "optional": true, "readonly": false, - "type": "BadgeSizeType", + "type": "\"large\" | \"xlarge\"", "default": "", "description": "Size of the badge, valid options are 'large' and 'xlarge'." }, @@ -3055,31 +3298,23 @@ "methods": [] }, "BadgeSlots": { + "description": "Defines valid slots in Badge component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Content can easily be customized with the default slot instead of using the built-in display." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "BadgeEmits": { - "values": "{}" + ] } } } }, - "badgedirective/BadgeDirective": {}, - "blockui/BlockUI": { + "badgedirective": { + "description": "Badge directive is a small status indicator for another element.\n\n- [Live Demo](https://primevue.org/badge)", "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -3088,7 +3323,112 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Info severity for Badge directive." + }, + { + "name": "success", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Success severity for Badge directive." + }, + { + "name": "warning", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Warning severity for Badge directive." + } + ], + "methods": [] + } + } + } + }, + "blockui": { + "description": "BlockUI represents people using icons, labels and images.\n\n[Live Demo](https://www.primevue.org/blockui)", + "components": { + "default": { + "description": "BlockUI represents people using icons, labels and images.", + "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.", + "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", + "slotDescription": "Defines the slots used by the component.", + "values": { + "BlockUIEmits": { + "description": "Defines valid emits in BlockUI component", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "block", + "parameters": [], + "returnType": "void", + "description": "Fired when the element gets blocked." + }, + { + "name": "unblock", + "parameters": [], + "returnType": "void", + "description": "Fired when the element gets unblocked." + } + ] + }, "BlockUIProps": { + "description": "Defines valid properties in BlockUI component", "relatedProp": "", "props": [ { @@ -3096,16 +3436,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "blocked", @@ -3127,30 +3467,32 @@ "methods": [] }, "BlockUISlots": { + "description": "Defines valid slots in BlockUI component", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content's slot." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "BlockUIEmits": { - "values": "{\n \"block\": \"Function, \",\n \"unblock\": \"Function, \"\n}" + ] } } } }, - "breadcrumb/Breadcrumb": { + "breadcrumb": { + "description": "Breadcrumb provides contextual information about page hierarchy.\n\n[Live Demo](https://www.primevue.org/breadcrumb/)", + "components": { + "default": { + "description": "Breadcrumb provides contextual information about page hierarchy.", + "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.", @@ -3159,7 +3501,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "BreadcrumbEmits": { + "description": "Defines valid emits in Breadcrumb component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "BreadcrumbProps": { + "description": "Defines valid properties in Breadcrumb component.", "relatedProp": "", "props": [ { @@ -3183,8 +3532,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "home", @@ -3206,30 +3555,39 @@ "methods": [] }, "BreadcrumbSlots": { + "description": "Defines valid slots in Breadcrumb component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "BreadcrumbEmits": { - "values": "{}" + ] } } } }, - "button/Button": { + "button": { + "description": "Button is an extension to standard button element with icons and theming.\n\n[Live Demo](https://www.primevue.org/button/)", + "components": { + "default": { + "description": "Button is an extension to standard button element with icons and theming.", + "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.", @@ -3238,7 +3596,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ButtonEmits": { + "description": "Defines valid emits in Button component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ButtonProps": { + "description": "Defines valid properties in Button component.", "relatedProp": "", "props": [ { @@ -3285,9 +3650,9 @@ "name": "iconPos", "optional": true, "readonly": false, - "type": "ButtonIconPosType", - "default": "", - "description": "Position of the icon, valid values are 'left', 'right', 'bottom' and 'top'.\nDefault value is 'left'." + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "left", + "description": "Position of the icon." }, { "name": "label", @@ -3302,7 +3667,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the button is in loading state." }, { @@ -3310,8 +3675,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in loading state.\nDefault value is 'pi pi-spinner pi-spin'." + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." }, { "name": "style", @@ -3326,25 +3691,17 @@ "extendedTypes": "ButtonHTMLAttributes" }, "ButtonSlots": { + "description": "Defines valid slots in Button component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "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." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ButtonEmits": { - "values": "{}" + ] } } } @@ -3352,7 +3709,7 @@ "calendar": { "description": "Calendar also known as DatePicker, is a form component to work with dates.\n\n[Live Demo](https://www.primevue.org/calendar/)", "components": { - "Calendar": { + "default": { "description": "Calendar also known as DatePicker, is a form component to work with dates.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -3370,7 +3727,7 @@ "values": { "CalendarBlurEvent": { "description": "Custom Calendar blur event.", - "relatedProp": "", + "relatedProp": "blur", "props": [ { "name": "originalEvent", @@ -3394,58 +3751,34 @@ "CalendarEmits": { "description": "Defines valid emits in Calendar component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "blur", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "event", + "optional": false, + "type": "CalendarBlurEvent", + "description": "Blur event" + } + ], + "returnType": "void", + "description": "Callback to invoke on blur of input field." }, { "name": "clear-click", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when clear button is clicked." }, - { - "name": "focus", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "keydown", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "month-change", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "today-click", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "year-change", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - } - ], - "methods": [ { "name": "date-select", "parameters": [ @@ -3459,6 +3792,19 @@ "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": [], @@ -3478,12 +3824,50 @@ "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": [ @@ -3496,12 +3880,25 @@ ], "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": "", + "relatedProp": "month-change", "props": [ { "name": "month", @@ -3992,9 +4389,52 @@ ], "methods": [] }, + "CalendarSlots": { + "description": "Defines valid slots in Calendar component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "date", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object" + } + ], + "returnType": "VNode[]", + "description": "Custom date template." + }, + { + "name": "decade", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object" + } + ], + "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": "", + "relatedProp": "year-change", "props": [ { "name": "month", @@ -4016,21 +4456,12 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "CalendarSlots": { - "values": "{}", - "description": "Defines valid slots in Calendar component." - } - } } }, "card": { "description": "Card is a flexible container component.\n\n[Live Demo](https://www.primevue.org/card/)", "components": { - "Card": { + "default": { "description": "Card is a flexible container component.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -4096,7 +4527,17 @@ } } }, - "carousel/Carousel": { + "carousel": { + "description": "Carousel is a content slider featuring various customization options.\n\n[Live Demo](https://www.primevue.org/carousel/)", + "components": { + "default": { + "description": "Carousel is a content slider featuring various customization options.", + "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.", @@ -4105,7 +4546,28 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "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." + } + ] + }, "CarouselProps": { + "description": "Defines valid properties in Carousel component.", "relatedProp": "", "props": [ { @@ -4113,15 +4575,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Time in milliseconds to scroll items automatically.\nDefault value is 0." + "default": "0", + "description": "Time in milliseconds to scroll items automatically." }, { "name": "circular", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines if scrolling would be infinite." }, { @@ -4161,23 +4623,23 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Number of items to scroll.\nDefault value is 1." + "default": "1", + "description": "Number of items to scroll." }, { "name": "numVisible", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Number of items per page.\nDefault value is 1." + "default": "1", + "description": "Number of items per page." }, { "name": "orientation", "optional": true, "readonly": false, - "type": "CarouselOrientationType", - "default": "", + "type": "\"horizontal\" | \"vertical\"", + "default": "horizontal", "description": "Specifies the layout of the component, valid values are 'horizontal' and 'vertical'." }, { @@ -4185,8 +4647,8 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Index of the first item.\nDefault value is 0." + "default": "0", + "description": "Index of the first item." }, { "name": "prevButtonProps", @@ -4209,16 +4671,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to display indicator container.\nDefault value is true." + "default": "true", + "description": "Whether to display indicator container." }, { "name": "showNavigators", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to display navigation buttons in container.\nDefault value is true." + "default": "true", + "description": "Whether to display navigation buttons in container." }, { "name": "value", @@ -4233,8 +4695,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Height of the viewport in vertical layout.\nDefault value is '300px'." + "default": "300px", + "description": "Height of the viewport in vertical layout." } ], "methods": [] @@ -4270,44 +4732,51 @@ "methods": [] }, "CarouselSlots": { + "description": "Defines valid slots in Carousel slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each item." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "CarouselEmits": { - "values": "{\n \"update:page\": \"Function, \"\n}" + ] } } } }, - "cascadeselect/CascadeSelect": { + "cascadeselect": { + "description": "CascadeSelect is a form component to select a value from a nested structure of options.\n\n[Live Demo](https://www.primevue.org/cascadeselect/)", + "components": { + "default": { + "description": "CascadeSelect is a form component to select a value from a nested structure of options.", + "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.", @@ -4317,7 +4786,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "CascadeSelectChangeEvent": { - "relatedProp": "", + "description": "Custom change event", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -4339,9 +4809,118 @@ "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": "", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -4364,14 +4943,15 @@ "extendedTypes": "CascadeSelectChangeEvent" }, "CascadeSelectProps": { + "description": "Defines valid properties in CascadeSelect component.", "relatedProp": "", "props": [ { "name": "appendTo", "optional": true, "readonly": false, - "type": "CascadeSelectAppendToType", - "default": "", + "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." }, { @@ -4395,8 +4975,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown.\nDefault value is true." + "default": "true", + "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." }, { "name": "dataKey", @@ -4411,7 +4991,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -4419,32 +4999,32 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dropdown.\nDefault value is 'pi pi-chevron-down'." + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." }, { "name": "emptyMessage", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed when there are no options available. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No available options'." + "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": "", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No selected item'." + "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", @@ -4483,7 +5063,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the dropdown is in loading state." }, { @@ -4491,8 +5071,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in loading state.\nDefault value is 'pi pi-spinner pi-spin'." + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." }, { "name": "modelValue", @@ -4506,7 +5086,7 @@ "name": "optionDisabled", "optional": true, "readonly": false, - "type": "CascadeSelectOptionDisabledType", + "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." }, @@ -4514,7 +5094,7 @@ "name": "optionGroupChildren", "optional": true, "readonly": false, - "type": "CascadeSelectOptionChildrenType", + "type": "string | string[] | Function", "default": "", "description": "Property name or getter function to retrieve the items of a group." }, @@ -4523,14 +5103,14 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the option group.\nDefault value is 'pi pi-angle-right'." + "default": "pi pi-angle-right", + "description": "Icon to display in the option group." }, { "name": "optionGroupLabel", "optional": true, "readonly": false, - "type": "CascadeSelectOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option group." }, @@ -4538,7 +5118,7 @@ "name": "optionLabel", "optional": true, "readonly": false, - "type": "CascadeSelectOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option." }, @@ -4546,7 +5126,7 @@ "name": "optionValue", "optional": true, "readonly": false, - "type": "CascadeSelectOptionValueType", + "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." }, @@ -4603,24 +5183,24 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} results are available'." + "default": "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": "", - "description": "When enabled, the focused option is selected/opened.\nDefault value is false." + "default": "false", + "description": "When enabled, the focused option is selected/opened." }, { "name": "selectionMessage", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} items selected'." + "default": "items selected", + "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { "name": "tabindex", @@ -4634,44 +5214,83 @@ "methods": [] }, "CascadeSelectSlots": { + "description": "Defines valid slots in CascadeSelect component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "indicator", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." }, { "name": "option", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each option." }, { "name": "value", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "value slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom value template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "CascadeSelectEmits": { - "values": "{\n \"before-hide\": \"Function, \",\n \"before-show\": \"Function, \",\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"click\": \"Function, \",\n \"focus\": \"Function, \",\n \"group-change\": \"Function, \",\n \"hide\": \"Function, \",\n \"show\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "chart/Chart": { + "chart": { + "description": "Chart groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/chart/)", + "components": { + "default": { + "description": "Chart groups a collection of contents in tabs.", + "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": [], + "returnType": "void", + "description": "Redraws the graph." + }, + { + "name": "reinit", + "parameters": [], + "returnType": "void", + "description": "Destroys the graph first and then creates it again." + } + ] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -4680,7 +5299,41 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ChartEmits": { + "description": "Defines valid emits in Chart component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "loaded", + "parameters": [ + { + "name": "chart", + "optional": false, + "type": "any", + "description": "Chart instance." + } + ], + "returnType": "void", + "description": "Callback to invoke when chart is loaded." + }, + { + "name": "select", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "ChartSelectEvent", + "description": "Custom select event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a tab gets expanded." + } + ] + }, "ChartProps": { + "description": "Defines valid properties in Chart component.", "relatedProp": "", "props": [ { @@ -4704,8 +5357,8 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Height of the chart in non-responsive mode.\nDefault value is 150." + "default": "150", + "description": "Height of the chart in non-responsive mode." }, { "name": "options", @@ -4736,14 +5389,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Width of the chart in non-responsive mode.\nDefault value is 300." + "default": "300", + "description": "Width of the chart in non-responsive mode." } ], "methods": [] }, "ChartSelectEvent": { - "relatedProp": "", + "description": "Custom select event.", + "relatedProp": "select", "props": [ { "name": "dataset", @@ -4778,17 +5432,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ChartEmits": { - "values": "{\n \"loaded\": \"Function, \",\n \"select\": \"Function, \"\n}" - } - } } }, - "checkbox/Checkbox": { + "checkbox": { + "description": "Checkbox is an extension to standard checkbox element with theming.\n\n[Live Demo](https://www.primevue.org/checkbox/)", + "components": { + "default": { + "description": "Accordion groups a collection of contents in tabs.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -4797,7 +5453,67 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -4937,17 +5653,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "CheckboxEmits": { - "values": "{\n \"change\": \"Function, \",\n \"click\": \"Function, \",\n \"input\": \"Function, \",\n \"update:page\": \"Function, \"\n}" - } - } } }, - "chip/Chip": { + "chip": { + "description": "Chip represents people using icons, labels and images.\n\n[Live Demo](https://www.primevue.org/chip)", + "components": { + "default": { + "description": "Chip represents people using icons, labels and images.", + "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.", @@ -4956,7 +5674,28 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -4988,7 +5727,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to display a remove icon." }, { @@ -4996,37 +5735,39 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon of the remove element.\nDefault value is 'pi pi-times-circle'." + "default": "pi pi-times-circle", + "description": "Icon of the remove element." } ], "methods": [] }, "ChipSlots": { + "description": "Defines valid slots in Chip component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Content can easily be customized with the default slot instead of using the built-in modes." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ChipEmits": { - "values": "{\n \"remove\": \"Function, \"\n}" + ] } } } }, - "chips/Chips": { + "chips": { + "description": "Chips groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/chips/)", + "components": { + "default": { + "description": "Chips is used to enter multiple values on an input field.", + "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.", @@ -5036,7 +5777,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "ChipsAddEvent": { - "relatedProp": "", + "description": "Custom remove event.", + "relatedProp": "remove", "props": [ { "name": "originalEvent", @@ -5058,7 +5800,54 @@ "methods": [], "extendedBy": "ChipsRemoveEvent" }, + "ChipsEmits": { + "description": "Defines valid emits in Chips component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "add", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "ChipsAddEvent", + "description": "Custom add event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a chip is added." + }, + { + "name": "remove", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "ChipsRemoveEvent", + "description": "Custom remove event." + } + ], + "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": [ { @@ -5177,8 +5966,8 @@ "methods": [] }, "ChipsRemoveEvent": { - "description": "", - "relatedProp": "", + "description": "Custom remove event.", + "relatedProp": "remove", "props": [ { "name": "originalEvent", @@ -5201,30 +5990,39 @@ "extendedTypes": "ChipsAddEvent" }, "ChipsSlots": { + "description": "Defines valid slots in Chips slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "chip", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "chip slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom chip template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ChipsEmits": { - "values": "{\n \"add\": \"Function, \",\n \"remove\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "colorpicker/ColorPicker": { + "colorpicker": { + "description": "ColorPicker groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/colorpicker/)", + "components": { + "default": { + "description": "ColorPicker groups a collection of contents in tabs.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -5234,7 +6032,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "ColorPickerChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -5255,15 +6054,61 @@ ], "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", "optional": true, "readonly": false, - "type": "ColorPickerAppendToType", - "default": "", + "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." }, { @@ -5271,39 +6116,39 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "defaultColor", "optional": true, "readonly": false, "type": "any", - "default": "", - "description": "Initial color to display when value is not defined.\nDefault value is ff0000." + "default": "ff0000", + "description": "Initial color to display when value is not defined." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { "name": "format", "optional": true, "readonly": false, - "type": "ColorPickerFormatType", - "default": "", + "type": "\"rgb\" | \"hex\" | \"hsb\"", + "default": "'hex'", "description": "Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'." }, { @@ -5311,7 +6156,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to display as an overlay or not." }, { @@ -5347,20 +6192,12 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ColorPickerEmits": { - "values": "{\n \"change\": \"Function, \",\n \"hide\": \"Function, \",\n \"show\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, "column": { "description": "Column component defines various options to specify corresponding features.\nIt is a helper component for DataTable and TreeTable.\n\n[Live Demo](https://www.primevue.org/datatable/)", "components": { - "Column": { + "default": { "description": "Column is a helper component for DataTable and TreeTable.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -5465,7 +6302,7 @@ "name": "column", "optional": false, "readonly": false, - "type": "Column", + "type": "default", "default": "", "description": "Column instance" }, @@ -5899,7 +6736,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t editorInitCallback: undefined, // undefined\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 }", + "type": "Object", "description": "body slot's params." } ], @@ -5912,7 +6749,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t editorCancelCallback: undefined, // undefined\n \t editorSaveCallback: undefined, // undefined\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n }", + "type": "Object", "description": "editor slot's params." } ], @@ -5925,7 +6762,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t field: string, // Column field.\n \t filterCallback: undefined, // undefined\n \t filterModel: ColumnFilterModelType, // Filter metadata\n }", + "type": "Object", "description": "filter slot's params." } ], @@ -5938,7 +6775,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t field: string, // Column field.\n \t filterCallback: undefined, // undefined\n \t filterModel: ColumnFilterModelType, // Filter metadata\n }", + "type": "Object", "description": "filter apply slot's params." } ], @@ -5951,7 +6788,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t field: string, // Column field.\n \t filterCallback: undefined, // undefined\n \t filterModel: ColumnFilterModelType, // Filter metadata\n }", + "type": "Object", "description": "filter clear slot's params." } ], @@ -5964,7 +6801,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t field: string, // Column field.\n \t filterCallback: undefined, // undefined\n \t filterModel: ColumnFilterModelType, // Filter metadata\n }", + "type": "Object", "description": "filter footer slot's params." } ], @@ -5977,7 +6814,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t field: string, // Column field.\n \t filterCallback: undefined, // undefined\n \t filterModel: ColumnFilterModelType, // Filter metadata\n }", + "type": "Object", "description": "filter header slot's params." } ], @@ -5990,7 +6827,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n }", + "type": "Object", "description": "footer slot's params." } ], @@ -6003,7 +6840,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t column: Column, // Column node.\n }", + "type": "Object", "description": "header slot's params." } ], @@ -6016,7 +6853,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": "Object", "description": "loading slot's params." } ], @@ -6029,7 +6866,16 @@ } }, "columngroup": { - "description": "", + "description": "Columns can be grouped at header and footer sections by defining a ColumnGroup component.\nIt is a helper component for DataTable.\n\n[Live Demo](https://www.primevue.org/datatable/)", + "components": { + "default": { + "description": "It is a helper component for DataTable.", + "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.", @@ -6038,7 +6884,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ColumnGroupEmits": { + "description": "Defines valid emits in ColumnGroup component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ColumnGroupProps": { + "description": "Defines valid properties in ColumnGroup component.", "relatedProp": "", "props": [ { @@ -6053,12 +6906,7 @@ "methods": [] }, "ColumnGroupSlots": { - "relatedProp": "", - "props": [], - "methods": [] - }, - "ColumnGroupEmits": { - "description": "", + "description": "Defines valid slots in ColumnGroup component.", "relatedProp": "", "props": [], "methods": [] @@ -6274,7 +7122,17 @@ } } }, - "confirmdialog/ConfirmDialog": { + "confirmdialog": { + "description": "ConfirmDialog uses a Dialog UI with confirmDialog method or tag.\n\n[Live Demo](https://www.primevue.org/confirmdialog)", + "components": { + "default": { + "description": "ConfirmDialog uses a Dialog UI with confirmDialog method or tag.", + "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.", @@ -6284,6 +7142,7 @@ "slotDescription": "Defines the slots used by the component.", "values": { "ConfirmDialogBreakpoints": { + "description": "Breakpoint metadata.", "relatedProp": "", "props": [ { @@ -6295,7 +7154,14 @@ ], "methods": [] }, + "ConfirmDialogEmits": { + "description": "Defines valid emits in ConfirmDialog component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ConfirmDialogProps": { + "description": "Defines valid properties in ConfirmDialog component.", "relatedProp": "", "props": [ { @@ -6318,30 +7184,39 @@ "methods": [] }, "ConfirmDialogSlots": { + "description": "Defines valid slots in ConfirmDialog component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "message", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "message slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom message template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ConfirmDialogEmits": { - "values": "{}" + ] } } } }, - "confirmpopup/ConfirmPopup": { + "confirmpopup": { + "description": "ConfirmPopup displays a confirmation overlay displayed relatively to its target.\n\n[Live Demo](https://www.primevue.org/confirmpopup)", + "components": { + "default": { + "description": "ConfirmPopup displays a confirmation overlay displayed relatively to its target.", + "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.", @@ -6350,7 +7225,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ConfirmPopupEmits": { + "description": "Defines valid emits in ConfirmPopup component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ConfirmPopupProps": { + "description": "Defines valid properties in ConfirmPopup component.", "relatedProp": "", "props": [ { @@ -6365,30 +7247,70 @@ "methods": [] }, "ConfirmPopupSlots": { + "description": "Defines valid slots in ConfirmPopup component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "message", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "message slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom message template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ConfirmPopupEmits": { - "values": "{}" + ] } } } }, - "contextmenu/ContextMenu": { + "contextmenu": { + "description": "ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu.\nRefer to documentation of the individual documentation of the with context menu support.\n\n[Live Demo](https://www.primevue.org/contextmenu/)", + "components": { + "default": { + "description": "ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu.\nRefer to documentation of the individual documentation of the with context menu support.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [ + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Hides the menu." + }, + { + "name": "show", + "parameters": [ + { + "name": "event", + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Shows the menu." + }, + { + "name": "toggle", + "parameters": [ + { + "name": "event", + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Toggles the visibility of the menu." + } + ] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -6397,15 +7319,73 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": "appendTo", "optional": true, "readonly": false, - "type": "ContextMenuAppendTo", - "default": "", + "type": "string | HTMLElement", + "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -6429,31 +7409,31 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "exact", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "global", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Attaches the menu to document instead of a particular item." }, { @@ -6476,25 +7456,24 @@ "methods": [] }, "ContextMenuSlots": { + "description": "Defines valid slots in ContextMenu component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ContextMenuEmits": { - "values": "{\n \"before-hide\": \"Function, \",\n \"before-show\": \"Function, \",\n \"blur\": \"Function, \",\n \"focus\": \"Function, \",\n \"hide\": \"Function, \",\n \"show\": \"Function, \"\n}" + ] } } } @@ -6502,7 +7481,7 @@ "datatable": { "description": "DataTable displays data in tabular format.\n\n[Live Demo](https://www.primevue.org/datatable/)", "components": { - "DataTable": { + "default": { "description": "DataTable displays data in tabular format.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -8582,7 +9561,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", + "type": "Object", "description": "expansion slot's params." } ], @@ -8601,7 +9580,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", + "type": "Object", "description": "group footer slot's params." } ], @@ -8614,7 +9593,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }" + "type": "Object" } ], "returnType": "VNode[]", @@ -8744,7 +9723,17 @@ } } }, - "dataview/DataView": { + "dataview": { + "description": "DataView displays data in grid or list layout with pagination and sorting features.\n\n[Live Demo](https://www.primevue.org/dataview/)", + "components": { + "default": { + "description": "DataView displays data in grid or list layout with pagination and sorting features.", + "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.", @@ -8753,8 +9742,55 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { - "DataViewPageEvent": { + "DataViewEmits": { + "description": "Defines valid slots in DataView component.", "relatedProp": "", + "props": [], + "methods": [ + { + "name": "page", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "DataViewPageEvent", + "description": "Custom page event." + } + ], + "returnType": "void", + "description": "Callback to invoke when page changes, the event object contains information about the new state." + }, + { + "name": "update:first", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the first changes." + }, + { + "name": "update:rows", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the rows changes." + } + ] + }, + "DataViewPageEvent": { + "description": "Custom change event.", + "relatedProp": "page", "props": [ { "name": "first", @@ -8792,6 +9828,7 @@ "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": [ { @@ -8799,16 +9836,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show it even there is only one page.\nDefault value is true." + "default": "true", + "description": "Whether to show it even there is only one page." }, { "name": "currentPageReportTemplate", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Template of the current page report element. It displays information about the pagination state. Default value is ({currentPage} of {totalPages}) whereas available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" + "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", @@ -8823,15 +9860,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Index of the first record to render.\nDefault value is 0." + "default": "0", + "description": "Index of the first record to render." }, { "name": "layout", "optional": true, "readonly": false, - "type": "any", - "default": "", + "type": "\"grid\" | \"list\"", + "default": "list", "description": "Layout of the items, valid values are 'list' and 'grid'." }, { @@ -8839,7 +9876,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines if data is loaded and interacted with in lazy manner." }, { @@ -8847,23 +9884,23 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Number of page links to display.\nDefault value is 5." + "default": "5", + "description": "Number of page links to display." }, { "name": "paginator", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When specified as true, enables the pagination." }, { "name": "paginatorPosition", "optional": true, "readonly": false, - "type": "DataTablePositionType", - "default": "", + "type": "\"both\" | \"top\" | \"bottom\"", + "default": "bottom", "description": "Position of the paginator, options are 'top','bottom' or 'both'." }, { @@ -8871,16 +9908,16 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Template of the paginator. It can be customized using the template property using the predefined keys, default value is 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown'. 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" + "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": "", - "description": "Number of rows to display per page.\nDefault value is 0." + "default": "0", + "description": "Number of rows to display per page." }, { "name": "rowsPerPageOptions", @@ -8894,7 +9931,7 @@ "name": "sortField", "optional": true, "readonly": false, - "type": "DataViewSortFieldType", + "type": "string | Function", "default": "", "description": "Property name or a getter function of data to use in sorting by default." }, @@ -8926,67 +9963,67 @@ "methods": [] }, "DataViewSlots": { + "description": "Defines valid slots in DataView component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "grid", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "list slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom list template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "list", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "list slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom list template." }, { "name": "paginatorend", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator end template." }, { "name": "paginatorstart", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator start template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "DataViewEmits": { - "values": "{\n \"page\": \"Function, \",\n \"update:first\": \"Function, \",\n \"update:rows\": \"Function, \"\n}" + ] } } } @@ -9033,7 +10070,7 @@ "deferredcontent": { "description": "DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.\n\n[Live Demo](https://www.primevue.org/deferredcontent/)", "components": { - "DeferredContent": { + "default": { "description": "DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -9083,7 +10120,17 @@ } } }, - "dialog/Dialog": { + "dialog": { + "description": "Dialog is a container to display content in an overlay window.\n\n[Live Demo](https://www.primevue.org/dialog)", + "components": { + "default": { + "description": "Dialog is a container to display content in an overlay window.", + "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.", @@ -9093,6 +10140,7 @@ "slotDescription": "Defines the slots used by the component.", "values": { "DialogBreakpoints": { + "description": "Custom breakpoint metadata.", "relatedProp": "", "props": [ { @@ -9104,32 +10152,110 @@ ], "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": "DialogAppendToType", - "default": "", - "description": "A valid query selector or an HTMLElement to specify where the dialog gets attached. Special keywords are 'body' for document body and 'self' for the element itself." + "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": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "breakpoints", @@ -9144,24 +10270,24 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Adds a close icon to the header to hide the dialog.\nDefault value is true." + "default": "true", + "description": "Adds a close icon to the header to hide the dialog." }, { "name": "closeIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dialog close button.\nDefault value is 'pi pi-times'." + "default": "pi pi-times", + "description": "Icon to display in the dialog close button." }, { "name": "closeOnEscape", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Specifies if pressing escape key should hide the dialog.\nDefault value is true." + "default": "true", + "description": "Specifies if pressing escape key should hide the dialog." }, { "name": "contentClass", @@ -9192,7 +10318,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Specifies if clicking the modal background should hide the dialog." }, { @@ -9200,8 +10326,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Enables dragging to change the position using header.\nDefault value is true." + "default": "true", + "description": "Enables dragging to change the position using header." }, { "name": "footer", @@ -9224,15 +10350,15 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Keeps dialog in the viewport when dragging.\nDefault value is true." + "default": "true", + "description": "Keeps dialog in the viewport when dragging." }, { "name": "maximizable", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the dialog can be displayed full screen." }, { @@ -9240,55 +10366,55 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dialog maximize button when dialog is not maximized.\nDefault value is 'pi pi-window-maximize'." + "default": "pi pi-window-maximize", + "description": "Icon to display in the dialog maximize button when dialog is not maximized." }, { "name": "minX", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Minimum value for the left coordinate of dialog in dragging.\nDefault value is 0." + "default": "0.", + "description": "Minimum value for the left coordinate of dialog in dragging." }, { "name": "minY", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Minimum value for the top coordinate of dialog in dragging.\nDefault value is 0." + "default": "0", + "description": "Minimum value for the top coordinate of dialog in dragging." }, { "name": "minimizeIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dialog maximize button when dialog is maximized.\nDefault value is 'pi pi-window-minimize'." + "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": "", + "default": "false", "description": "Defines if background should be blocked when dialog is displayed." }, { "name": "position", "optional": true, "readonly": false, - "type": "DialogPositionType", - "default": "", - "description": "Position of the dialog, options are 'center', 'top', 'bottom', 'left', 'right', 'topleft', 'topright', 'bottomleft' or 'bottomright'." + "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": "", + "default": "false", "description": "When enabled dialog is displayed in RTL direction." }, { @@ -9296,8 +10422,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show the header or not.\nDefault value is true." + "default": "true", + "description": "Whether to show the header or not." }, { "name": "style", @@ -9312,46 +10438,36 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Specifies the visibility of the dialog." } ], "methods": [] }, "DialogSlots": { + "description": "Defines valid slots in Dialog component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Default content slot." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "DialogEmits": { - "values": "{\n \"after-hide\": \"Function, \",\n \"dragend\": \"Function, \",\n \"hide\": \"Function, \",\n \"maximize\": \"Function, \",\n \"show\": \"Function, \",\n \"unmaximize\": \"Function, \",\n \"update:visible\": \"Function, \"\n}" + ] } } } @@ -9382,9 +10498,9 @@ } }, "divider": { - "description": "Divider is used to separate contents.\n\n[Live Demo](https://www.primefaces.org/primevue/divider)", + "description": "Divider is used to separate contents.\n\n[Live Demo](https://primevue.org/divider)", "components": { - "Divider": { + "default": { "description": "Divider is used to separate contents.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -9452,7 +10568,17 @@ } } }, - "dock/Dock": { + "dock": { + "description": "Dock is a navigation component consisting of menuitems.\n\n[Live Demo](https://www.primevue.org/dock/)", + "components": { + "default": { + "description": "Dock is a navigation component consisting of menuitems.", + "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.", @@ -9461,7 +10587,41 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -9493,8 +10653,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "menuId", @@ -9516,8 +10676,8 @@ "name": "position", "optional": true, "readonly": false, - "type": "DockPositionType", - "default": "", + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "bottom", "description": "Position of element." }, { @@ -9548,33 +10708,47 @@ "methods": [] }, "DockSlots": { + "description": "Defines valid slots in Dock component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "icon", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "icon slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom icon content." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item content." } - ], - "methods": [] + ] }, "DockTooltipOptions": { + "description": "Defines tooltip options", "relatedProp": "", "props": [ { "name": "event", "optional": false, "readonly": false, - "type": "string", + "type": "undefined | \"focus\" | \"hover\"", "default": "", "description": "Event to show the tooltip, valid values are hover and focus." }, @@ -9582,31 +10756,33 @@ "name": "position", "optional": false, "readonly": false, - "type": "string", - "default": "", + "type": "undefined | \"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "bottom", "description": "Position of element." }, { "name": "[key: string]", "optional": false, "readonly": false, - "type": "string" + "type": "any" } ], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "DockEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"focus\": \"Function, \"\n}" - } - } } }, - "dropdown/Dropdown": { + "dropdown": { + "description": "Dropdown also known as Select, is used to choose an item from a collection of options.\n\n[Live Demo](https://www.primevue.org/dropdown/)", + "components": { + "default": { + "description": "Dropdown also known as Select, is used to choose an item from a collection of options.", + "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.", @@ -9616,7 +10792,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "DropdownChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -9637,8 +10814,105 @@ ], "methods": [] }, - "DropdownFilterEvent": { + "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 filetr event.", + "relatedProp": "filter", "props": [ { "name": "originalEvent", @@ -9660,15 +10934,16 @@ "methods": [] }, "DropdownProps": { + "description": "Defines valid properties in Dropdown component.", "relatedProp": "", "props": [ { "name": "appendTo", "optional": true, "readonly": false, - "type": "DropdownAppendToType", - "default": "", - "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": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { "name": "aria-label", @@ -9691,24 +10966,24 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to focus on the filter element when the overlay panel is shown.\nDefault value is false." + "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": "", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown.\nDefault value is true." + "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": "", - "description": "Icon to display in clear button.\nDefault value is 'pi pi-times'." + "default": "pi pi-times", + "description": "Icon to display in clear button." }, { "name": "clearIconProps", @@ -9739,8 +11014,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dropdown.\nDefault value is 'pi pi-chevron-down'." + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." }, { "name": "editable", @@ -9755,24 +11030,24 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No selected item'." + "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", @@ -9795,8 +11070,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in filter input.\nDefault value is 'pi pi-search'." + "default": "pi pi-search", + "description": "Icon to display in filter input." }, { "name": "filterInputProps", @@ -9818,8 +11093,8 @@ "name": "filterMatchMode", "optional": true, "readonly": false, - "type": "DropdownFilterMatchModeType", - "default": "", + "type": "\"endsWith\" | \"startsWith\" | \"contains\"", + "default": "contains", "description": "Defines the filtering algorithm to use when searching the options." }, { @@ -9827,8 +11102,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} results are available'." + "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", @@ -9883,8 +11158,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in loading state.\nDefault value is 'pi pi-spinner pi-spin'." + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." }, { "name": "modelValue", @@ -9898,7 +11173,7 @@ "name": "optionDisabled", "optional": true, "readonly": false, - "type": "DropdownOptionDisabledType", + "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." }, @@ -9906,7 +11181,7 @@ "name": "optionGroupChildren", "optional": true, "readonly": false, - "type": "DropdownOptionChildrenType", + "type": "string | Function", "default": "", "description": "Property name or getter function that refers to the children options of option group." }, @@ -9914,7 +11189,7 @@ "name": "optionGroupLabel", "optional": true, "readonly": false, - "type": "DropdownOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option group." }, @@ -9922,7 +11197,7 @@ "name": "optionLabel", "optional": true, "readonly": false, - "type": "DropdownOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option." }, @@ -9930,7 +11205,7 @@ "name": "optionValue", "optional": true, "readonly": false, - "type": "DropdownOptionValueType", + "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." }, @@ -9987,24 +11262,24 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value.\nDefault value is '200px'." + "default": "200px", + "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." }, { "name": "selectOnFocus", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "When enabled, the focused option is selected.\nDefault value is false." + "default": "false", + "description": "When enabled, the focused option is selected." }, { "name": "selectionMessage", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} items selected'." + "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": "showClear", @@ -10034,93 +11309,135 @@ "methods": [] }, "DropdownSlots": { + "description": "Defines valid slots in Dropdown component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "content slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." }, { "name": "emptyfilter", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty filter template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template of panel." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template of panel." }, { "name": "indicator", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." }, { "name": "loader", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "loader slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom loader template." }, { "name": "option", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." }, { "name": "optiongroup", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option group slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option group template." }, { "name": "value", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "value slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom value template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "DropdownEmits": { - "values": "{\n \"before-hide\": \"Function, \",\n \"before-show\": \"Function, \",\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"filter\": \"Function, \",\n \"focus\": \"Function, \",\n \"hide\": \"Function, \",\n \"show\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "dynamicdialog/DynamicDialog": { + "dynamicdialog": { + "description": "DynamicDialogs can be created dynamically with any component as the content using a DialogService.\n\n- [Live Demo](https://primevue.org/dynamicdialog)", + "components": { + "default": { + "description": "DynamicDialogs can be created dynamically with any component as the content using a DialogService.", + "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.", @@ -10129,25 +11446,25 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "DynamicDialogEmits": { + "description": "Defines valid emits in DynamicDialog component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "DynamicDialogProps": { + "description": "Defines valid properties in DynamicDialog component.", "relatedProp": "", "props": [], "methods": [] }, "DynamicDialogSlots": { + "description": "Defines valid slots in DynamicDialog component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "DynamicDialogEmits": { - "values": "{}" - } - } } }, "dynamicdialogoptions/DynamicDialogOptions": { @@ -10300,7 +11617,17 @@ } } }, - "editor/Editor": { + "editor": { + "description": "Editor groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/editor/)", + "components": { + "default": { + "description": "Editor groups a collection of contents in tabs.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -10309,8 +11636,68 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { - "EditorLoadEvent": { + "EditorEmits": { + "description": "Defines valid emits in Editor component.", "relatedProp": "", + "props": [], + "methods": [ + { + "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": "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": "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": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] + }, + "EditorLoadEvent": { + "description": "Custom load event.", + "relatedProp": "load", "props": [ { "name": "instance", @@ -10324,6 +11711,7 @@ "methods": [] }, "EditorProps": { + "description": "Defines valid properties in Editor component.", "relatedProp": "", "props": [ { @@ -10378,7 +11766,8 @@ "methods": [] }, "EditorSelectionChangeEvent": { - "relatedProp": "", + "description": "Custom selection change event.", + "relatedProp": "selection-change", "props": [ { "name": "htmlValue", @@ -10432,6 +11821,7 @@ "methods": [] }, "EditorSlots": { + "description": "Defines valid slots in Editor slots.", "relatedProp": "", "props": [ { @@ -10445,7 +11835,8 @@ "methods": [] }, "EditorTextChangeEvent": { - "relatedProp": "", + "description": "Custom text change event.", + "relatedProp": "text-change", "props": [ { "name": "delta", @@ -10491,20 +11882,12 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "EditorEmits": { - "values": "{\n \"load\": \"Function, \",\n \"selection-change\": \"Function, \",\n \"text-change\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, "fieldset": { "description": "Fieldset is a grouping component with the optional content toggle feature.\n\n[Live Demo](https://www.primevue.org/fieldset/)", "components": { - "Fieldset": { + "default": { "description": "Fieldset is a grouping component with the optional content toggle feature.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -10639,7 +12022,17 @@ } } }, - "fileupload/FileUpload": { + "fileupload": { + "description": "FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.\n\n[Live Demo](https://www.primevue.org/fileupload/)", + "components": { + "default": { + "description": "FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.", + "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.", @@ -10649,7 +12042,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "FileUploadBeforeSendEvent": { - "relatedProp": "", + "description": "Custom before send event.", + "relatedProp": "before-send", "props": [ { "name": "formData", @@ -10671,7 +12065,8 @@ "methods": [] }, "FileUploadBeforeUploadEvent": { - "relatedProp": "", + "description": "Custom before upload event.", + "relatedProp": "before-upload", "props": [ { "name": "formData", @@ -10692,8 +12087,138 @@ ], "methods": [] }, - "FileUploadErrorEvent": { + "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": "error", "props": [ { "name": "files", @@ -10715,7 +12240,8 @@ "methods": [] }, "FileUploadProgressEvent": { - "relatedProp": "", + "description": "Custom progress event.", + "relatedProp": "progress", "props": [ { "name": "originalEvent", @@ -10737,6 +12263,7 @@ "methods": [] }, "FileUploadProps": { + "description": "Defines valid properties in FileUpload component.", "relatedProp": "", "props": [ { @@ -10752,7 +12279,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled, upload begins automatically after selection is completed." }, { @@ -10760,7 +12287,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "", + "default": "pi pi-fw pi-times", "description": "Icon of the cancel button." }, { @@ -10768,15 +12295,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Label of the cancel button. Defaults to PrimeVue Locale configuration.\nDefault value is 'Cancel'." + "default": "Cancel", + "description": "Label of the cancel button. Defaults to PrimeVue Locale configuration." }, { "name": "chooseIcon", "optional": true, "readonly": false, "type": "string", - "default": "", + "default": "pi pi-fw pi-plus", "description": "Icon of the choose button." }, { @@ -10800,7 +12327,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration." }, { @@ -10808,7 +12335,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Disables the upload functionality." }, { @@ -10824,24 +12351,24 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Message to display when number of files to be uploaded exceeeds the limit.\nDefault value is 'Maximum number of files exceeded, limit is {0} at most.'." + "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": "", - "description": "Message of the invalid fize size.\nDefault value is '{0}: Invalid file size, file size should be smaller than {1}.'." + "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": "", - "description": "Message of the invalid fize type.\nDefault value is '{0}: Invalid file type, allowed file types: {1}.'." + "default": ": Invalid file type.", + "description": "Message of the invalid fize type." }, { "name": "maxFileSize", @@ -10855,8 +12382,8 @@ "name": "mode", "optional": true, "readonly": false, - "type": "FileUploadModeType", - "default": "", + "type": "\"basic\" | \"advanced\"", + "default": "advanced", "description": "Defines the UI of the component, possible values are 'advanced' and 'basic'." }, { @@ -10864,7 +12391,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Used to select multiple files at once from file dialog." }, { @@ -10880,24 +12407,24 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Width of the image thumbnail in pixels.\nDefault value is 50." + "default": "50", + "description": "Width of the image thumbnail in pixels." }, { "name": "showCancelButton", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show the cancel button.\nDefault value is true." + "default": "true", + "description": "Whether to show the cancel button." }, { "name": "showUploadButton", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show the upload button.\nDefault value is true." + "default": "true", + "description": "Whether to show the upload button." }, { "name": "style", @@ -10912,7 +12439,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "", + "default": "pi pi-fw pi-upload", "description": "Icon of the upload button." }, { @@ -10921,7 +12448,7 @@ "readonly": false, "type": "string", "default": "", - "description": "Label of the upload button. Defaults to PrimeVue Locale configuration.\nDefault value is 'Upload'." + "description": "Label of the upload button. Defaults to PrimeVue Locale configuration." }, { "name": "url", @@ -10936,14 +12463,15 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates." } ], "methods": [] }, "FileUploadRemoveEvent": { - "relatedProp": "", + "description": "Custom remove event.", + "relatedProp": "remove", "props": [ { "name": "file", @@ -10965,7 +12493,8 @@ "methods": [] }, "FileUploadRemoveUploadedFile": { - "relatedProp": "", + "description": "Custom remove upload file event.", + "relatedProp": "removeUploadFile", "props": [ { "name": "file", @@ -10987,7 +12516,8 @@ "methods": [] }, "FileUploadSelectEvent": { - "relatedProp": "", + "description": "Custom select event.", + "relatedProp": "select", "props": [ { "name": "files", @@ -11009,34 +12539,45 @@ "methods": [] }, "FileUploadSlots": { + "description": "Defines valid slots in FileUpload slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object" + } + ], + "returnType": "VNode[]", + "description": "Custom uploaded content template." }, { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content when there is no selected file." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object" + } + ], + "returnType": "VNode[]", + "description": "Custom header content template." } - ], - "methods": [] + ] }, "FileUploadUploadEvent": { - "relatedProp": "", + "description": "Custom upload event.", + "relatedProp": "upload", "props": [ { "name": "files", @@ -11058,7 +12599,8 @@ "methods": [] }, "FileUploadUploaderEvent": { - "relatedProp": "", + "description": "Custom uploader event.", + "relatedProp": "uploader", "props": [ { "name": "files", @@ -11072,17 +12614,52 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", + } + }, + "focustrap": { + "description": "Focus Trap keeps focus within a certain DOM element while tabbing.\n\n- [Live Demo](https://primevue.org/focustrap)", + "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.", + "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", + "slotDescription": "Defines the slots used by the component.", "values": { - "FileUploadEmits": { - "values": "{\n \"before-send\": \"Function, \",\n \"before-upload\": \"Function, \",\n \"clear\": \"Function, \",\n \"error\": \"Function, \",\n \"progress\": \"Function, \",\n \"remove\": \"Function, \",\n \"removeUploadedFile\": \"Function, \",\n \"select\": \"Function, \",\n \"upload\": \"Function, \",\n \"uploader\": \"Function, \"\n}" + "FocusTrapDirectiveBinding": { + "description": "Binding of FocusTrap directive.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "FocusTrapOptions", + "default": "", + "description": "Value of the FocusTrap." + } + ], + "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": [] } } } }, - "focustrap/FocusTrap": {}, "fullcalendar/FullCalendar": { "interfaces": { "description": "Defines the custom interfaces used by the module.", @@ -11128,7 +12705,17 @@ } } }, - "galleria/Galleria": { + "galleria": { + "description": "Galleria is an advanced content gallery component.\n\n[Live Demo](https://www.primevue.org/galleria/)", + "components": { + "default": { + "description": "Galleria is an advanced content gallery component.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -11137,7 +12724,41 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "GalleriaEmits": { + "description": "Defines valid emits in Galleria component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:activeIndex", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "Index of new active item." + } + ], + "returnType": "void", + "description": "Emitted when the active index changes." + }, + { + "name": "update:visible", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the visible changes." + } + ] + }, "GalleriaProps": { + "description": "Defines valid properties in Galleria component.", "relatedProp": "", "props": [ { @@ -11145,15 +12766,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Index of the first item.\nDefault value is 0." + "default": "0", + "description": "Index of the first item." }, { "name": "autoPlay", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Items are displayed with a slideshow in autoPlay mode." }, { @@ -11161,15 +12782,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "changeItemOnIndicatorHover", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled, item is changed on indicator hover." }, { @@ -11177,7 +12798,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines if scrolling would be infinite." }, { @@ -11209,7 +12830,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to display the component on fullscreen." }, { @@ -11224,8 +12845,8 @@ "name": "indicatorsPosition", "optional": true, "readonly": false, - "type": "GalleriaIndicatorsPositionType", - "default": "", + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "bottom", "description": "Position of indicators." }, { @@ -11249,7 +12870,7 @@ "optional": true, "readonly": false, "type": "number", - "default": "", + "default": "3", "description": "Number of items per page." }, { @@ -11273,7 +12894,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to display indicator container." }, { @@ -11281,7 +12902,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled, indicator container is displayed on item container." }, { @@ -11289,7 +12910,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to display navigation buttons in item section." }, { @@ -11297,7 +12918,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to display navigation buttons on item hover." }, { @@ -11305,23 +12926,23 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to display navigation buttons in thumbnail container.\nDefault value is true." + "default": "true", + "description": "Whether to display navigation buttons in thumbnail container." }, { "name": "showThumbnails", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to display thumbnail container.\nDefault value is true." + "default": "true", + "description": "Whether to display thumbnail container." }, { "name": "thumbnailsPosition", "optional": true, "readonly": false, - "type": "GalleriaThumbnailsPositionType", - "default": "", + "type": "\"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "bottom", "description": "Position of thumbnails." }, { @@ -11329,8 +12950,8 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Time in milliseconds to scroll items.\nDefault value is 4000." + "default": "4000", + "description": "Time in milliseconds to scroll items." }, { "name": "value", @@ -11345,15 +12966,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Height of the viewport in vertical thumbnail.\nDefault value is '300px'." + "default": "300px", + "description": "Height of the viewport in vertical thumbnail." }, { "name": "visible", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Specifies the visibility of the mask on fullscreen mode." } ], @@ -11382,65 +13003,109 @@ "methods": [] }, "GalleriaSlots": { + "description": "Defines valid slots in Galleria slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "caption", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "caption slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom caption template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "indicator", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "indicator slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom indicator template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." }, { "name": "thumbnail", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "thumbnail slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom thumbnail template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "GalleriaEmits": { - "values": "{\n \"update:activeIndex\": \"Function, \",\n \"update:visible\": \"Function, \"\n}" + ] } } } }, - "image/Image": { + "image": { + "description": "Displays an image with preview and tranformation options. For multiple image, see Galleria.\n\n[Live Demo](https://www.primevue.org/image/)", + "components": { + "default": { + "description": "Displays an image with preview and tranformation options. For multiple image, see Galleria.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [ + { + "name": "error", + "parameters": [], + "returnType": "void", + "description": "Triggered when an error occurs while loading an image file." + }, + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Triggered when the preview overlay is hidden." + }, + { + "name": "show", + "parameters": [], + "returnType": "void", + "description": "Triggered when the preview overlay is shown." + } + ] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -11449,7 +13114,13 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ImageEmits": { + "relatedProp": "", + "props": [], + "methods": [] + }, "ImageProps": { + "description": "Defines valid properties in Image component.", "relatedProp": "", "props": [ { @@ -11473,37 +13144,39 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Controls the preview functionality." } ], "methods": [] }, "ImageSlots": { + "description": "Defines valid slots in Image slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "indicator", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ImageEmits": { - "values": "{}" + ] } } } }, - "inlinemessage/InlineMessage": { + "inlinemessage": { + "description": "InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message.\n\n[Live Demo](https://www.primevue.org/inlinemessage/)", + "components": { + "default": { + "description": "InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message.", + "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.", @@ -11512,45 +13185,53 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "InlineMessageEmits": { + "relatedProp": "", + "props": [], + "methods": [] + }, "InlineMessageProps": { + "description": "Defines valid properties in InlineMessage component.", "relatedProp": "", "props": [ { "name": "severity", "optional": true, "readonly": false, - "type": "InlineMessageSeverityType", - "default": "", + "type": "\"error\" | \"success\" | \"info\" | \"warn\"", + "default": "'info'", "description": "Severity level of the message." } ], "methods": [] }, "InlineMessageSlots": { + "description": "Defines valid slots in InlineMessage slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Default custom slot." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "InlineMessageEmits": { - "values": "{}" + ] } } } }, - "inplace/Inplace": { + "inplace": { + "description": "Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.\n\n[Live Demo](https://www.primevue.org/inplace)", + "components": { + "default": { + "description": "Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.", + "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.", @@ -11559,7 +13240,54 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "InplaceEmits": { + "description": "Defines valid emits in Inplace component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "close", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when inplace is closed." + }, + { + "name": "open", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when inplace is opened." + }, + { + "name": "update:active", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the active changes." + } + ] + }, "InplaceProps": { + "description": "Defines valid properties in Inplace component.", "relatedProp": "", "props": [ { @@ -11567,7 +13295,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the content is displayed or not." }, { @@ -11575,7 +13303,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Displays a button to switch back to display mode." }, { @@ -11591,15 +13319,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the close button.\nDefault value is 'pi pi-times'." + "default": "pi pi-times", + "description": "Icon to display in the close button." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the element should be disabled." }, { @@ -11614,37 +13342,38 @@ "methods": [] }, "InplaceSlots": { + "description": "Defines valid slots in Inplace component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "display", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom display template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "InplaceEmits": { - "values": "{\n \"close\": \"Function, \",\n \"open\": \"Function, \",\n \"update:active\": \"Function, \"\n}" + ] } } } }, - "inputmask/InputMask": { + "inputmask": { + "description": "InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.\n\n[Live Demo](https://www.primevue.org/inputmask/)", + "components": { + "default": { + "description": "InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.", + "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.", @@ -11653,7 +13382,86 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "InputMaskEmits": { + "description": "Defines valid emits in InputMask component.", + "relatedProp": "", + "props": [ + { + "name": "complete", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "keypress", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "paste", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + } + ], + "methods": [ + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event" + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event" + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "keydown", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event" + } + ], + "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": [ { @@ -11661,8 +13469,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Clears the incomplete value on blur.\nDefault value is true." + "default": "true", + "description": "Clears the incomplete value on blur." }, { "name": "mask", @@ -11680,20 +13488,28 @@ "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.\nDefault value is '_'." + "default": "_", + "description": "Placeholder character in mask, default is underscore." }, { "name": "unmask", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines if model sets the raw unmasked value to bound value or the formatted mask value." } ], @@ -11705,17 +13521,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "InputMaskEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"complete\": \"Function, \",\n \"focus\": \"Function, \",\n \"keydown\": \"Function, \",\n \"keypress\": \"Function, \",\n \"paste\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, - "inputnumber/InputNumber": { + "inputnumber": { + "description": "InputNumber is an input component to provide numerical input.\n\n[Live Demo](https://www.primevue.org/inputnumber/)", + "components": { + "default": { + "description": "InputNumber is an input component to provide numerical input.", + "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.", @@ -11725,7 +13543,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "InputNumberBlurEvent": { - "relatedProp": "", + "description": "Custom blur event.", + "relatedProp": "blur", "props": [ { "name": "originalEvent", @@ -11746,8 +13565,68 @@ ], "methods": [] }, - "InputNumberInputEvent": { + "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": "input", "props": [ { "name": "originalEvent", @@ -11769,6 +13648,7 @@ "methods": [] }, "InputNumberProps": { + "description": "Defines valid properties in InputNumber component.", "relatedProp": "", "props": [ { @@ -11776,8 +13656,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Determines whether the input field is empty.\nDefault value is true." + "default": "true", + "description": "Determines whether the input field is empty." }, { "name": "aria-label", @@ -11799,9 +13679,9 @@ "name": "buttonLayout", "optional": true, "readonly": false, - "type": "InputNumberButtonLayoutType", + "type": "\"horizontal\" | \"vertical\" | \"stacked\"", "default": "", - "description": "Layout of the buttons." + "description": "Layout of the buttons.\nDefault value is 'stacked'." }, { "name": "currency", @@ -11848,7 +13728,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -11856,7 +13736,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "true", "description": "Whether to format the value." }, { @@ -11864,8 +13744,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Highlights automatically the input value.\nDefault value is false." + "default": "false", + "description": "Highlights automatically the input value." }, { "name": "incrementButtonClass", @@ -11935,9 +13815,9 @@ "name": "localeMatcher", "optional": true, "readonly": false, - "type": "InputNumberLocaleMatcherType", + "type": "\"best fit\" | \"lookup\"", "default": "", - "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." + "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.\nDefault value is 'best fit'" }, { "name": "max", @@ -11975,9 +13855,9 @@ "name": "mode", "optional": true, "readonly": false, - "type": "InputNumberModeType", + "type": "\"decimal\" | \"currency\"", "default": "", - "description": "Defines the behavior of the component." + "description": "Defines the behavior of the component.\nDefault value is 'decimal'." }, { "name": "modelValue", @@ -12008,7 +13888,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that an input field is read-only." }, { @@ -12016,7 +13896,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Displays spinner buttons." }, { @@ -12024,8 +13904,8 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Step factor to increment/decrement the value.\nDefault value is 1." + "default": "1", + "description": "Step factor to increment/decrement the value." }, { "name": "suffix", @@ -12040,29 +13920,32 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators.\nDefault value is true." + "default": "true", + "description": "Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators." } ], "methods": [] }, "InputNumberSlots": { + "description": "Defines valid slots in InputNumber component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "InputNumberEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"focus\": \"Function, \",\n \"input\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, - "inputswitch/InputSwitch": { + "inputswitch": { + "description": "InputSwitch is used to select a boolean value.\n\n[Live Demo](https://www.primevue.org/inputswitch/)", + "components": { + "default": { + "description": "InputSwitch is used to select a boolean value.", + "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.", @@ -12071,7 +13954,67 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -12095,7 +14038,7 @@ "optional": true, "readonly": false, "type": "any", - "default": "", + "default": "false", "description": "Value in unchecked state." }, { @@ -12143,7 +14086,7 @@ "optional": true, "readonly": false, "type": "any", - "default": "", + "default": "true", "description": "Value in checked state." } ], @@ -12155,17 +14098,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "InputSwitchEmits": { - "values": "{\n \"change\": \"Function, \",\n \"click\": \"Function, \",\n \"input\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, - "inputtext/InputText": { + "inputtext": { + "description": "InputText renders a text field to enter data.\n\n[Live Demo](https://www.primevue.org/inputtext/)", + "components": { + "default": { + "description": "InputText renders a text field to enter 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.", @@ -12174,7 +14119,28 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": "", "props": [ { @@ -12190,19 +14156,12 @@ "extendedTypes": "InputHTMLAttributes" }, "InputTextSlots": { + "description": "Defines valid slots in InputText component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "InputTextEmits": { - "values": "{\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, "knob": { @@ -12247,7 +14206,7 @@ ] }, "KnobProps": { - "description": "Defines valid properties in Knob component. In addition to these, all properties of HTMLDivElement can be used in this component.", + "description": "Defines valid properties in Knob component.", "relatedProp": "", "props": [ { @@ -12271,7 +14230,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -12303,7 +14262,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "", + "default": "var(--surface-border, LightGray)", "description": "Background color of the range." }, { @@ -12311,7 +14270,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component value cannot be edited." }, { @@ -12319,7 +14278,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "true", "description": "Whether the show the value inside the knob." }, { @@ -12335,7 +14294,7 @@ "optional": true, "readonly": false, "type": "number", - "default": "", + "default": "1", "description": "Step factor to increment/decrement the value." }, { @@ -12343,7 +14302,7 @@ "optional": true, "readonly": false, "type": "number", - "default": "100", + "default": "14", "description": "Width of the knob stroke." }, { @@ -12351,7 +14310,7 @@ "optional": true, "readonly": false, "type": "number", - "default": "", + "default": "0", "description": "Index of the element in tabbing order." }, { @@ -12359,7 +14318,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "", + "default": "var(--text-color-secondary, Black)", "description": "Color of the value text." }, { @@ -12367,7 +14326,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "", + "default": "var(--primary-color, Black)", "description": "Background of the value." }, { @@ -12375,7 +14334,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "", + "default": "{value}", "description": "Template string of the value." } ], @@ -12390,7 +14349,17 @@ } } }, - "listbox/Listbox": { + "listbox": { + "description": "ListBox is used to select one or more values from a list of items.\n\n[Live Demo](https://www.primevue.org/listbox/)", + "components": { + "default": { + "description": "ListBox is used to select one or more values from a list of items.", + "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.", @@ -12400,7 +14369,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "ListboxChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -12421,8 +14391,81 @@ ], "methods": [] }, - "ListboxFilterEvent": { + "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": "filter", "props": [ { "name": "originalEvent", @@ -12444,6 +14487,7 @@ "methods": [] }, "ListboxProps": { + "description": "Defines valid properties in Listbox component.", "relatedProp": "", "props": [ { @@ -12467,8 +14511,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to focus on the first visible or selected element.\nDefault value is true." + "default": "true", + "description": "Whether to focus on the first visible or selected element." }, { "name": "dataKey", @@ -12483,7 +14527,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When specified, disables the component." }, { @@ -12491,31 +14535,31 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No selected item'." + "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": "", + "default": "false", "description": "When specified, displays a filter input at header." }, { @@ -12531,8 +14575,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in filter input.\nDefault value is 'pi pi-search'." + "default": "pi pi-search", + "description": "Icon to display in filter input." }, { "name": "filterInputProps", @@ -12554,8 +14598,8 @@ "name": "filterMatchMode", "optional": true, "readonly": false, - "type": "ListboxFilterMatchModeType", - "default": "", + "type": "\"endsWith\" | \"startsWith\" | \"contains\"", + "default": "contains", "description": "Defines the filtering algorithm to use when searching the options." }, { @@ -12563,8 +14607,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} results are available'." + "default": "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", @@ -12587,8 +14631,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "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.\nDefault value is true." + "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", @@ -12603,14 +14647,14 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When specified, allows selecting multiple values." }, { "name": "optionDisabled", "optional": true, "readonly": false, - "type": "ListboxOptionDisabledType", + "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." }, @@ -12618,7 +14662,7 @@ "name": "optionGroupChildren", "optional": true, "readonly": false, - "type": "ListboxOptionChildrenType", + "type": "string | Function", "default": "", "description": "Property name or getter function that refers to the children options of option group." }, @@ -12626,7 +14670,7 @@ "name": "optionGroupLabel", "optional": true, "readonly": false, - "type": "ListboxOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option group." }, @@ -12634,7 +14678,7 @@ "name": "optionLabel", "optional": true, "readonly": false, - "type": "ListboxOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option." }, @@ -12642,7 +14686,7 @@ "name": "optionValue", "optional": true, "readonly": false, - "type": "ListboxOptionValueType", + "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." }, @@ -12659,16 +14703,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "When enabled, the focused option is selected.\nDefault value is false." + "default": "false", + "description": "When enabled, the focused option is selected." }, { "name": "selectionMessage", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} items selected'." + "default": "items selected", + "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration." }, { "name": "tabindex", @@ -12690,79 +14734,116 @@ "methods": [] }, "ListboxSlots": { + "description": "Defines valid slots in Listbox component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "content slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." }, { "name": "emptyfilter", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom emptyfilter template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "loader", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "loader slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom loader template." }, { "name": "option", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." }, { "name": "optiongroup", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "optiongroup slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom optiongroup template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ListboxEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"filter\": \"Function, \",\n \"focus\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "megamenu/MegaMenu": { + "megamenu": { + "description": "MegaMenu is navigation component that displays submenus together.\n\n[Live Demo](https://www.primevue.org/megamenu/)", + "components": { + "default": { + "description": "MegaMenu is navigation component that displays submenus together.", + "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.", @@ -12771,7 +14852,41 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -12795,7 +14910,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -12803,8 +14918,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "model", @@ -12818,8 +14933,8 @@ "name": "orientation", "optional": true, "readonly": false, - "type": "MegaMenuOrientationType", - "default": "", + "type": "\"horizontal\" | \"vertical\"", + "default": "horizontal", "description": "Defines the orientation." }, { @@ -12834,44 +14949,87 @@ "methods": [] }, "MegaMenuSlots": { + "description": "Defines valid slots in MegaMenu component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "end", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom end template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." }, { "name": "start", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "MegaMenuEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"focus\": \"Function, \"\n}" + ] } } } }, - "menu/Menu": { + "menu": { + "description": "Menu is a navigation / command component that supports dynamic and static positioning.\n\n[Live Demo](https://www.primevue.org/menu/)", + "components": { + "default": { + "description": "Menu is a navigation / command component that supports dynamic and static positioning.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [ + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Hides the overlay." + }, + { + "name": "show", + "parameters": [ + { + "name": "event", + "type": "Event", + "description": "Browser event." + }, + { + "name": "target", + "type": "any", + "description": "Target element" + } + ], + "returnType": "void", + "description": "Shows the overlay." + }, + { + "name": "toggle", + "parameters": [ + { + "name": "event", + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Toggles the visibility of the overlay." + } + ] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -12880,15 +15038,49 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": "appendTo", "optional": true, "readonly": false, - "type": "MenuAppendToType", - "default": "", + "type": "string | HTMLElement", + "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -12912,24 +15104,24 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "exact", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "model", @@ -12944,7 +15136,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines if menu would displayed as a popup." }, { @@ -12959,44 +15151,51 @@ "methods": [] }, "MenuSlots": { + "description": "Defines valid slots in Menu component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "end", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom end template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." }, { "name": "start", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "MenuEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"focus\": \"Function, \"\n}" + ] } } } }, - "menubar/Menubar": { + "menubar": { + "description": "Menubar is a horizontal menu component.\n\n[Live Demo](https://www.primevue.org/menubar/)", + "components": { + "default": { + "description": "Menubar is a horizontal menu component.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -13005,7 +15204,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "MenubarEmits": { + "description": "Defines valid emits in Menubar component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "MenubarProps": { + "description": "Defines valid properties in Menubar component.", "relatedProp": "", "props": [ { @@ -13037,8 +15243,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "model", @@ -13052,55 +15258,48 @@ "methods": [] }, "MenubarSlots": { + "description": "Defines valid slots in Menubar component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "end", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom end template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." }, { "name": "start", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "MenubarEmits": { - "values": "{}" + ] } } } }, - "menuitem/MenuItem": { - "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", - "values": { - "MenuItem": { - "relatedProp": "", - "props": [ + "menuitem": { + "description": "PrimeVue menu components share a common api to specify the menuitems and submenus.", + "model": { + "MenuItem": { + "description": "Defines model of MenuItem API.", + "props": { + "description": "", + "values": [ { "name": "class", "optional": true, @@ -13109,19 +15308,12 @@ "default": "", "description": "Style class of the menuitem." }, - { - "name": "command", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" - }, { "name": "disabled", "optional": true, "readonly": false, - "type": "MenuItemDisabledType", - "default": "", + "type": "boolean | Function", + "default": "false", "description": "A boolean or a function to return a boolean to specify if the item is disabled." }, { @@ -13152,7 +15344,7 @@ "name": "label", "optional": true, "readonly": false, - "type": "MenuItemLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an item." }, @@ -13161,7 +15353,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines the item as a separator." }, { @@ -13200,21 +15392,25 @@ "name": "visible", "optional": true, "readonly": false, - "type": "MenuItemVisibleType", - "default": "", + "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": [] - }, + ] + } + } + }, + "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.", + "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", + "slotDescription": "Defines the slots used by the component.", + "values": { "MenuItemCommandEvent": { - "relatedProp": "", + "description": "Custom command event.", + "relatedProp": "command", "props": [ { "name": "item", @@ -13242,23 +15438,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "MenuItemDisabledType": { - "values": "boolean | Function | undefined" - }, - "MenuItemLabelType": { - "values": "string | Function | undefined" - }, - "MenuItemVisibleType": { - "values": "boolean | Function | undefined" - } - } } }, - "message/Message": { + "message": { + "description": "Message groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/message/)", + "components": { + "default": { + "description": "Messages is used to display inline messages with various severities.", + "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.", @@ -13267,7 +15459,28 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "MessageEmits": { + "description": "Defines valid emits in Message component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "close", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a message is closed." + } + ] + }, "MessageProps": { + "description": "Defines valid properties in Message component.", "relatedProp": "", "props": [ { @@ -13275,8 +15488,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether the message can be closed manually using the close icon.\nDefault value is true." + "default": "true", + "description": "Whether the message can be closed manually using the close icon." }, { "name": "closeButtonProps", @@ -13291,8 +15504,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the message close button.\nDefault value is 'pi pi-times'." + "default": "'pi pi-times'", + "description": "Icon to display in the message close button." }, { "name": "icon", @@ -13307,15 +15520,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Delay in milliseconds to close the message automatically.\nDefault value is 3000." + "default": "3000", + "description": "Delay in milliseconds to close the message automatically." }, { "name": "severity", "optional": true, "readonly": false, - "type": "MessageSeverityType", - "default": "", + "type": "\"error\" | \"success\" | \"info\" | \"warn\"", + "default": "'info'", "description": "Severity level of the message." }, { @@ -13323,37 +15536,64 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "true", "description": "When enabled, message is not removed automatically." } ], "methods": [] }, "MessageSlots": { + "description": "Defines valid slots in Message slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Default custom slot." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "MessageEmits": { - "values": "{\n \"close\": \"Function, \"\n}" + ] } } } }, - "multiselect/MultiSelect": { + "multiselect": { + "description": "MultiSelect is used to select multiple items from a collection.\n\n[Live Demo](https://www.primevue.org/multiselect/)", + "components": { + "default": { + "description": "MultiSelect is used to select multiple items from a collection.", + "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": [ + { + "name": "isFocus", + "type": "boolean", + "description": "Decides whether to focus on the component. Default value is false." + } + ], + "returnType": "void", + "description": "Shows the overlay." + } + ] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -13363,7 +15603,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "MultiSelectAllChangeEvent": { - "relatedProp": "", + "description": "Custom all change event.", + "relatedProp": "['selectall-change']", "props": [ { "name": "checked", @@ -13385,7 +15626,8 @@ "methods": [] }, "MultiSelectChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -13406,8 +15648,118 @@ ], "methods": [] }, - "MultiSelectFilterEvent": { + "MultiSelectEmits": { + "description": "Defines valid emits in MultiSelect 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": "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." + } + ] + }, + "MultiSelectFilterEvent": { + "description": "Custom filter event", + "relatedProp": "filter", "props": [ { "name": "originalEvent", @@ -13429,14 +15781,15 @@ "methods": [] }, "MultiSelectProps": { + "description": "Defines valid properties in MultiSelect component.", "relatedProp": "", "props": [ { "name": "appendTo", "optional": true, "readonly": false, - "type": "MultiSelectAppendToType", - "default": "", + "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." }, { @@ -13460,24 +15813,24 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to focus on the filter element when the overlay panel is shown.\nDefault value is false." + "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": "", - "description": "Whether to focus on the first visible or selected element when the overlay panel is shown.\nDefault value is true." + "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": "", - "description": "Icon to display in the checkboxes.\nDefault value is 'pi pi-check'." + "default": "pi pi-check", + "description": "Icon to display in the checkboxes." }, { "name": "closeButtonProps", @@ -13492,8 +15845,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dropdown close button.\nDefault value is 'pi pi-times'." + "default": "pi pi-times", + "description": "Icon to display in the dropdown close button." }, { "name": "dataKey", @@ -13508,15 +15861,15 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { "name": "display", "optional": true, "readonly": false, - "type": "MultiSelectDisplayType", - "default": "", + "type": "\"comma\" | \"chip\"", + "default": "comma", "description": "Defines how the selected items are displayed." }, { @@ -13524,39 +15877,39 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the dropdown.\nDefault value is 'pi pi-chevron-down'." + "default": "pi pi-chevron-down", + "description": "Icon to display in the dropdown." }, { "name": "emptyFilterMessage", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "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": "", - "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No selected item'." + "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": "", + "default": "false", "description": "When specified, displays a filter input at header." }, { @@ -13572,8 +15925,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in filter input.\nDefault value is 'pi pi-search'." + "default": "pi pi-search", + "description": "Icon to display in filter input." }, { "name": "filterInputProps", @@ -13595,8 +15948,8 @@ "name": "filterMatchMode", "optional": true, "readonly": false, - "type": "MultiSelectFilterMatchModeType", - "default": "", + "type": "\"endsWith\" | \"startsWith\" | \"contains\"", + "default": "contains", "description": "Defines the filtering algorithm to use when searching the options." }, { @@ -13604,8 +15957,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} results are available'." + "default": "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", @@ -13636,7 +15989,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the multiselect is in loading state." }, { @@ -13644,8 +15997,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in loading state.\nDefault value is 'pi pi-spinner pi-spin'." + "default": "pi pi-spinner pi-spin", + "description": "Icon to display in loading state." }, { "name": "maxSelectedLabels", @@ -13667,7 +16020,7 @@ "name": "optionDisabled", "optional": true, "readonly": false, - "type": "MultiSelectOptionDisabledType", + "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." }, @@ -13675,7 +16028,7 @@ "name": "optionGroupChildren", "optional": true, "readonly": false, - "type": "MultiSelectOptionChildrenType", + "type": "string | Function", "default": "", "description": "Property name or getter function that refers to the children options of option group." }, @@ -13683,7 +16036,7 @@ "name": "optionGroupLabel", "optional": true, "readonly": false, - "type": "MultiSelectOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option group." }, @@ -13691,7 +16044,7 @@ "name": "optionLabel", "optional": true, "readonly": false, - "type": "MultiSelectOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option." }, @@ -13699,7 +16052,7 @@ "name": "optionValue", "optional": true, "readonly": false, - "type": "MultiSelectOptionValueType", + "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." }, @@ -13748,15 +16101,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in chip remove action.\nDefault value is 'pi pi-times-circle'." + "default": "pi pi-times-circle", + "description": "Icon to display in chip remove action." }, { "name": "resetFilterOnHide", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Clears the filter value when hiding the dropdown." }, { @@ -13764,15 +16117,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value.\nDefault value is '200px'." + "default": "200px", + "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." }, { "name": "selectAll", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether all data is selected." }, { @@ -13780,8 +16133,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Label to display after exceeding max selected labels.\nDefault value is '{0} items selected'." + "default": "items selected", + "description": "Label to display after exceeding max selected labels." }, { "name": "selectionLimit", @@ -13796,16 +16149,16 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.\nDefault value is '{0} items selected'." + "default": "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, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show the header checkbox to toggle the selection of all items at once.\nDefault value is true." + "default": "true", + "description": "Whether to show the header checkbox to toggle the selection of all items at once." }, { "name": "tabindex", @@ -13827,100 +16180,148 @@ "methods": [] }, "MultiSelectSlots": { + "description": "Defines valid slots in MultiSelect component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "chip", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "chip slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom chip template." }, { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "content slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." }, { "name": "emptyfilter", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom emptyfilter template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "indicator", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." }, { "name": "loader", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "loader slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom loader template." }, { "name": "option", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option template." }, { "name": "optiongroup", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option group slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom option group template." }, { "name": "value", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "value slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom value template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "MultiSelectEmits": { - "values": "{\n \"before-hide\": \"Function, \",\n \"before-show\": \"Function, \",\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"filter\": \"Function, \",\n \"focus\": \"Function, \",\n \"hide\": \"Function, \",\n \"selectall-change\": \"Function, \",\n \"show\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "orderlist/OrderList": { + "orderlist": { + "description": "OrderList is used to managed the order of a collection.\n\n- [Live Demo](https://primevue.org/orderlist)", + "components": { + "default": { + "description": "OrderList is used to sort a collection.", + "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.", @@ -13929,7 +16330,67 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -13953,8 +16414,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled.\nDefault value is '960px'." + "default": "960px", + "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled." }, { "name": "dataKey", @@ -13985,8 +16446,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "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.\nDefault value is true." + "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", @@ -14033,8 +16494,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether the list optimizes layout based on screen size.\nDefault value is true." + "default": "true", + "description": "Whether the list optimizes layout based on screen size." }, { "name": "selection", @@ -14064,7 +16525,8 @@ "methods": [] }, "OrderListReorderEvent": { - "relatedProp": "", + "description": "Custom reorder event", + "relatedProp": "reorder", "props": [ { "name": "direction", @@ -14094,7 +16556,8 @@ "methods": [] }, "OrderListSelectionChangeEvent": { - "relatedProp": "", + "description": "Custom selection change event", + "relatedProp": "selection-change", "props": [ { "name": "originalEvent", @@ -14116,51 +16579,57 @@ "methods": [] }, "OrderListSlots": { + "description": "Defines valid slots in OrderList component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "controlsend", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom controls end template." }, { "name": "controlsstart", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom controls start template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "OrderListEmits": { - "values": "{\n \"reorder\": \"Function, \",\n \"selection-change\": \"Function, \",\n \"update:modelValue\": \"Function, \",\n \"update:selection\": \"Function, \"\n}" + ] } } } }, - "organizationchart/OrganizationChart": { + "organizationchart": { + "description": "OrganizationChart visualizes hierarchical organization data.\n\n[Live Demo](https://primevue.org/organizationchart)", + "components": { + "default": { + "description": "OrganizationChart visualizes hierarchical organization 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.", @@ -14181,7 +16650,93 @@ ], "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.", "relatedProp": "", "props": [ { @@ -14250,6 +16805,7 @@ "methods": [] }, "OrganizationChartProps": { + "description": "Defines valid properties in OrganizationChart component.", "relatedProp": "", "props": [ { @@ -14280,7 +16836,7 @@ "name": "selectionMode", "optional": true, "readonly": false, - "type": "OrganizationChartSelectionModeType", + "type": "\"multiple\" | \"single\"", "default": "", "description": "Type of the selection." }, @@ -14308,28 +16864,79 @@ "methods": [] }, "OrganizationChartSlots": { + "description": "Defines valid slots in OrganizationChart component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" - }, - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "Function" + "parameters": [ + { + "name": "node", + "optional": false, + "type": "any" + } + ], + "returnType": "VNode[]", + "description": "Custom content template." } - ], - "methods": [] + ] } } } }, - "overlaypanel/OverlayPanel": { + "overlaypanel": { + "description": "OverlayPanel is a container component positioned as connected to its target.\n\n- [Live Demo](https://primevue.org/overlaypanel)", + "components": { + "default": { + "description": "OverlayPanel, also known as Popover, is a container component that can overlay other components on page.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [ + { + "name": "hide", + "parameters": [], + "returnType": "void", + "description": "Hides the overlay." + }, + { + "name": "show", + "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": "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." + } + ], + "returnType": "void", + "description": "Toggles the visibility of the overlay." + } + ] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -14339,6 +16946,7 @@ "slotDescription": "Defines the slots used by the component.", "values": { "OverlayPanelBreakpoints": { + "description": "OverlayPanel breakpoint metadata.", "relatedProp": "", "props": [ { @@ -14350,15 +16958,35 @@ ], "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": "OverlayPanelAppendToType", - "default": "", + "type": "string | HTMLElement", + "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { @@ -14366,16 +16994,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "breakpoints", @@ -14390,45 +17018,47 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Enables to hide the overlay when outside is clicked.\nDefault value is true." + "default": "true", + "description": "Enables to hide the overlay when outside is clicked." }, { "name": "showCloseIcon", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled, displays a close icon at top right corner." } ], "methods": [] }, "OverlayPanelSlots": { + "description": "Defines valid slots in OverlayPanel component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "OverlayPanelEmits": { - "values": "{\n \"hide\": \"Function, \",\n \"show\": \"Function, \"\n}" + ] } } } }, - "paginator/Paginator": { + "paginator": { + "description": "Paginator is a generic component to display content in paged format.\n\n- [Paginator](https://primevue.org/paginator)", + "components": { + "default": { + "description": "Paginator is a generic widget to display content in paged format.", + "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.", @@ -14438,6 +17068,7 @@ "slotDescription": "Defines the slots used by the component.", "values": { "PageState": { + "description": "Paginator page state metadata.", "relatedProp": "", "props": [ { @@ -14475,7 +17106,54 @@ ], "methods": [] }, + "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": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the first changes." + }, + { + "name": "update:rows", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the rows changes." + } + ] + }, "PaginatorProps": { + "description": "Defines valid properties in Paginator component.", "relatedProp": "", "props": [ { @@ -14483,40 +17161,40 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show the paginator even there is only one page.\nDefault value is true." + "default": "true", + "description": "Whether to show the paginator even there is only one page." }, { "name": "currentPageReportTemplate", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Template of the current page report element. It displays information about the pagination state. Default value is ({currentPage} of {totalPages}) whereas available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" + "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": "", - "description": "Zero-relative number of the first row to be displayed.\nDefault value is 0." + "default": "0", + "description": "Zero-relative number of the first row to be displayed." }, { "name": "pageLinkSize", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Number of page links to display.\nDefault value is 5." + "default": "5", + "description": "Number of page links to display." }, { "name": "rows", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Data count to display per page.\nDefault value is 0." + "default": "0", + "description": "Data count to display per page." }, { "name": "rowsPerPageOptions", @@ -14539,39 +17217,44 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Number of total records.\nDefault value is 0." + "default": "0", + "description": "Number of total records." } ], "methods": [] }, "PaginatorSlots": { + "description": "Defines valid slots in Paginator component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "end", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "end slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom end template." }, { "name": "start", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "start slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom start template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "PaginatorEmits": { - "values": "{\n \"page\": \"Function, \",\n \"update:first\": \"Function, \",\n \"update:rows\": \"Function, \"\n}" + ] } } } @@ -14579,7 +17262,7 @@ "panel": { "description": "Panel is a container with the optional content toggle feature.\n\n[Live Demo](https://www.primevue.org/panel/)", "components": { - "Panel": { + "default": { "description": "Panel is a container with the optional content toggle feature.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -14706,7 +17389,17 @@ } } }, - "panelmenu/PanelMenu": { + "panelmenu": { + "description": "PanelMenu is a hybrid of Accordion and Tree components.\n\n[Live Demo](https://www.primevue.org/panelmenu/)", + "components": { + "default": { + "description": "PanelMenu is a hybrid of Accordion and Tree components.", + "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.", @@ -14715,8 +17408,55 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { - "PanelMenuExpandedKeys": { + "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": "expandedKeys", "props": [ { "name": "[key: string]", @@ -14728,8 +17468,8 @@ "methods": [] }, "PanelMenuPanelCloseEvent": { - "description": "", - "relatedProp": "", + "description": "Custom panel close event.", + "relatedProp": "['panel-close']", "props": [ { "name": "item", @@ -14752,7 +17492,8 @@ "extendedTypes": "PanelMenuPanelOpenEvent" }, "PanelMenuPanelOpenEvent": { - "relatedProp": "", + "description": "Custom panel open event.", + "relatedProp": "['panel-open']", "props": [ { "name": "item", @@ -14775,6 +17516,7 @@ "extendedBy": "PanelMenuPanelCloseEvent" }, "PanelMenuProps": { + "description": "Defines valid properties in PanelMenu component.", "relatedProp": "", "props": [ { @@ -14782,7 +17524,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "true", "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { @@ -14813,30 +17555,39 @@ "methods": [] }, "PanelMenuSlots": { + "description": "Defines valid slots in PanelMenu component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each item." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "PanelMenuEmits": { - "values": "{\n \"panel-close\": \"Function, \",\n \"panel-open\": \"Function, \",\n \"update:expandedKeys\": \"Function, \"\n}" + ] } } } }, - "password/Password": { + "password": { + "description": "Password displays strength indicator for password fields.\n\n[Live Demo](https://www.primevue.org/password/)", + "components": { + "default": { + "description": "Password displays strength indicator for password fields.", + "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.", @@ -14845,16 +17596,37 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "PasswordEmits": { + "description": "Defines valid emits in Password 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." + } + ] + }, "PasswordProps": { + "description": "Defines valid properties in Password component.", "relatedProp": "", "props": [ { "name": "appendTo", "optional": true, "readonly": false, - "type": "PasswordAppendToType", - "default": "", - "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": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { "name": "aria-label", @@ -14877,7 +17649,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -14885,16 +17657,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show the strength indicator or not.\nDefault value is true." + "default": "true", + "description": "Whether to show the strength indicator or not." }, { "name": "hideIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to hide displaying the password as plain text.\nDefault value is 'pi pi-eye-slash'." + "default": "pi pi-eye-slash", + "description": "Icon to hide displaying the password as plain text." }, { "name": "inputClass", @@ -14941,8 +17713,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Regex for a medium level password.\nDefault value is '^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})'." + "default": "^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})", + "description": "Regex for a medium level password." }, { "name": "modelValue", @@ -15005,16 +17777,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "When present, it specifies that an input field must be filled out before submitting the form.\nDefault value is false." + "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": "", - "description": "Icon to show displaying the password as plain text.\nDefault value is 'pi pi-eye'." + "default": "pi pi-eye", + "description": "Icon to show displaying the password as plain text." }, { "name": "strongLabel", @@ -15029,15 +17801,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Regex for a strong level password.\nDefault value is '^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})'." + "default": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})", + "description": "Regex for a strong level password." }, { "name": "toggleMask", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to show an icon to display the password as plain text." }, { @@ -15053,44 +17825,44 @@ "extendedTypes": "InputHTMLAttributes" }, "PasswordSlots": { + "description": "Defines valid slots in Password component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "PasswordEmits": { - "values": "{\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "picklist/PickList": { + "picklist": { + "description": "PickList is used to reorder items between different lists.\n\n- [Live Demo](https://primevue.org/picklist)", + "components": { + "default": { + "description": "PickList is used to reorder items between different lists.", + "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.", @@ -15099,9 +17871,120 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { - "PickListMoveAllToSourceEvent": { - "description": "", + "PickListEmits": { + "description": "Defines valid emits in PickList component.", "relatedProp": "", + "props": [], + "methods": [ + { + "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." + }, + { + "name": "move-all-to-target", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "PickListMoveAllToTargetEvent", + "description": "Custom move all to target event." + } + ], + "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." + }, + { + "name": "reorder", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "PickListReorderEvent", + "description": "Custom reorder event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the list is reordered." + }, + { + "name": "selection-change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "PickListSelectionChangeEvent", + "description": "Custom selection change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when one or more items are moved to the other list." + }, + { + "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." + } + ] + }, + "PickListMoveAllToSourceEvent": { + "description": "Custom move-all-to-source event.", + "relatedProp": "move-to-target", "props": [ { "name": "items", @@ -15124,8 +18007,8 @@ "extendedTypes": "PickListMoveToTargetEvent" }, "PickListMoveAllToTargetEvent": { - "description": "", - "relatedProp": "", + "description": "Custom move-all-to-target event.", + "relatedProp": "move-to-target", "props": [ { "name": "items", @@ -15148,8 +18031,8 @@ "extendedTypes": "PickListMoveToTargetEvent" }, "PickListMoveToSourceEvent": { - "description": "", - "relatedProp": "", + "description": "Custom move-to-source event.", + "relatedProp": "move-to-target", "props": [ { "name": "items", @@ -15172,7 +18055,8 @@ "extendedTypes": "PickListMoveToTargetEvent" }, "PickListMoveToTargetEvent": { - "relatedProp": "", + "description": "Custom move-to-target event.", + "relatedProp": "move-to-target", "props": [ { "name": "items", @@ -15195,6 +18079,7 @@ "extendedBy": "PickListMoveAllToTargetEvent,PickListMoveToSourceEvent,PickListMoveAllToSourceEvent" }, "PickListProps": { + "description": "Defines valid properties in PickList component.", "relatedProp": "", "props": [ { @@ -15202,8 +18087,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled.\nDefault value is '960px'." + "default": "960px", + "description": "The breakpoint to define the maximum width boundary when responsiveness is enabled." }, { "name": "dataKey", @@ -15226,8 +18111,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "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.\nDefault value is true." + "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", @@ -15306,8 +18191,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether the list optimizes layout based on screen size.\nDefault value is true." + "default": "true", + "description": "Whether the list optimizes layout based on screen size." }, { "name": "selection", @@ -15322,7 +18207,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to show buttons of source list." }, { @@ -15330,7 +18215,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to show buttons of target list." }, { @@ -15346,7 +18231,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to displays rows with alternating colors." }, { @@ -15369,7 +18254,8 @@ "methods": [] }, "PickListReorderEvent": { - "relatedProp": "", + "description": "Custom reorder event.", + "relatedProp": "reorder", "props": [ { "name": "direction", @@ -15407,7 +18293,8 @@ "methods": [] }, "PickListSelectionChangeEvent": { - "relatedProp": "", + "description": "Custom selection change event.", + "relatedProp": "selection-change", "props": [ { "name": "originalEvent", @@ -15429,88 +18316,78 @@ "methods": [] }, "PickListSlots": { + "description": "Defines valid slots in PickList component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." }, { "name": "movecontrolsend", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom move controls end template." }, { "name": "movecontrolsstart", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom move controls start template." }, { "name": "sourcecontrolsend", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom source controls end template." }, { "name": "sourcecontrolsstart", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom source controls start template." }, { "name": "sourceheader", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom source header template." }, { "name": "targetcontrolsend", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom target controls end template." }, { "name": "targetcontrolsstart", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom target controls start template." }, { "name": "targetheader", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom target header template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "PickListEmits": { - "values": "{\n \"move-all-to-source\": \"Function, \",\n \"move-all-to-target\": \"Function, \",\n \"move-to-source\": \"Function, \",\n \"move-to-target\": \"Function, \",\n \"reorder\": \"Function, \",\n \"selection-change\": \"Function, \",\n \"update:modelValue\": \"Function, \",\n \"update:selection\": \"Function, \"\n}" + ] } } } @@ -15570,7 +18447,17 @@ } } }, - "progressbar/ProgressBar": { + "progressbar": { + "description": "ProgressBar is a process status indicator.\n\n[Live Demo](https://www.primevue.org/progressbar)", + "components": { + "default": { + "description": "\n\n[Live Demo](https://www.primevue.org/progressbar/)\n--- ---\n![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)", + "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.", @@ -15579,15 +18466,22 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ProgressBarEmits": { + "description": "Defines valid emits in ProgressBar component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ProgressBarProps": { + "description": "Defines valid properties in ProgressBar component.", "relatedProp": "", "props": [ { "name": "mode", "optional": true, "readonly": false, - "type": "ProgressBarModeType", - "default": "", + "type": "\"indeterminate\" | \"determinate\"", + "default": "determinate", "description": "Defines the mode of the progress" }, { @@ -15595,8 +18489,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to display the progress bar value.\nDefault value is true." + "default": "true", + "description": "Whether to display the progress bar value." }, { "name": "value", @@ -15610,30 +18504,32 @@ "methods": [] }, "ProgressBarSlots": { + "description": "Defines valid slots in ProgressBar component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content slot." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ProgressBarEmits": { - "values": "{}" + ] } } } }, - "progressspinner/ProgressSpinner": { + "progressspinner": { + "description": "ProgressSpinner is a process status indicator.\n\n[Live Demo](https://www.primevue.org/progressspinner)", + "components": { + "default": { + "description": "ProgressSpinner is a process status indicator.", + "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.", @@ -15642,7 +18538,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ProgressSpinnerEmits": { + "description": "Defines valid emits in ProgressSpinner component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ProgressSpinnerProps": { + "description": "Defines valid properties in ProgressSpinner component.", "relatedProp": "", "props": [ { @@ -15650,8 +18553,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Duration of the rotate animation.\nDefault value is 2s." + "default": "2s", + "description": "Duration of the rotate animation." }, { "name": "fill", @@ -15666,29 +18569,32 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Width of the circle stroke.\nDefault value is 2." + "default": "2", + "description": "Width of the circle stroke." } ], "methods": [] }, "ProgressSpinnerSlots": { + "description": "Defines valid slots in ProgressSpinner component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ProgressSpinnerEmits": { - "values": "{}" - } - } } }, - "radiobutton/RadioButton": { + "radiobutton": { + "description": "RadioButton is an extension to standard radio button element with theming.\n\n[Live Demo](https://www.primevue.org/radiobutton/)", + "components": { + "default": { + "description": "RadioButton is an extension to standard radio button element with theming.", + "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.", @@ -15697,7 +18603,54 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -15789,17 +18742,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "RadioButtonEmits": { - "values": "{\n \"change\": \"Function, \",\n \"click\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, - "rating/Rating": { + "rating": { + "description": "Rating component is a star based selection input.\n\n[Live Demo](https://www.primevue.org/rating/)", + "components": { + "default": { + "description": "Rating component is a star based selection input.", + "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.", @@ -15809,7 +18764,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "RatingChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -15830,7 +18786,67 @@ ], "methods": [] }, + "RatingEmits": { + "description": "Defines valid emits in Rating 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": "RatingChangeEvent", + "description": "Custom change event." + } + ], + "returnType": "void", + "description": "Callback to invoke when a suggestion is selected." + }, + { + "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": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] + }, "RatingProps": { + "description": "Defines valid properties in Rating component.", "relatedProp": "", "props": [ { @@ -15838,23 +18854,23 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "When specified a cancel icon is displayed to allow clearing the value.\nDefault value is true." + "default": "true", + "description": "When specified a cancel icon is displayed to allow clearing the value." }, { "name": "cancelIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon for the cancelable state.\nDefault value is pi pi-ban." + "default": "pi pi-ban", + "description": "Icon for the cancelable state." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the element should be disabled." }, { @@ -15878,23 +18894,23 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon for the off state.\nDefault value is pi pi-star-fill." + "default": "pi pi-star-fill", + "description": "Icon for the off state." }, { "name": "onIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon for the on state.\nDefault value is pi pi-star." + "default": "pi pi-star", + "description": "Icon for the on state." }, { "name": "readonly", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that component is read-only." }, { @@ -15902,53 +18918,85 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Number of stars.\nDefault value is 5." + "default": "5", + "description": "Number of stars." } ], "methods": [] }, "RatingSlots": { + "description": "Defines valid slots in Rating component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "cancelicon", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom cancel icon template." }, { "name": "officon", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "off icon slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom off icon template." }, { "name": "onicon", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "on icon slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom on icon template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "RatingEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"focus\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] + } + } + } + }, + "ripple": { + "description": "Ripple directive adds ripple effect to the host element.\n\n- [Live Demo](https://primevue.org/ripple)", + "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.", + "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", + "slotDescription": "Defines the slots used by the component.", + "values": { + "RippleDirectiveBinding": { + "description": "Binding of Ripple directive.", + "relatedProp": "", + "props": [], + "methods": [], + "extendedTypes": "Omit" } } } }, - "ripple/Ripple": {}, "row": { - "description": "", + "description": "Row component is a helper component used to create grouping structures in DataTable.\n\n[Live Demo](https://www.primereact.org/datatable/)", + "components": { + "default": { + "description": "Row component is a helper component used to create grouping structures in DataTable.", + "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.", @@ -15958,16 +19006,19 @@ "slotDescription": "Defines the slots used by the component.", "values": { "RowEmits": { + "description": "Defines valid emits in Row component.", "relatedProp": "", "props": [], "methods": [] }, "RowProps": { + "description": "Defines valid properties in Row component.", "relatedProp": "", "props": [], "methods": [] }, "RowSlots": { + "description": "Defines valid slots in Row component.", "relatedProp": "", "props": [], "methods": [] @@ -15978,7 +19029,7 @@ "scrollpanel": { "description": "ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.\n\n[Live Demo](https://www.primevue.org/scrollpanel/)", "components": { - "ScrollPanel": { + "default": { "description": "ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar..", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -16031,7 +19082,17 @@ } } }, - "scrolltop/ScrollTop": { + "scrolltop": { + "description": "ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.\n\n[Live Demo](https://www.primevue.org/scrolltop/)", + "components": { + "default": { + "description": "ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.", + "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.", @@ -16040,7 +19101,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ScrollTopEmits": { + "description": "Defines valid emits in ScrollTop component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ScrollTopProps": { + "description": "Defines valid properties in ScrollTop component.", "relatedProp": "", "props": [ { @@ -16048,23 +19116,23 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump.\nDefault value is 'smooth'." + "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": "", - "description": "Icon to display.\nDefault value is 'pi pi-chevron-up'." + "default": "pi pi-chevron-up", + "description": "Icon to display." }, { "name": "target", "optional": true, "readonly": false, - "type": "ScrollTopTargetType", - "default": "", + "type": "\"window\" | \"parent\"", + "default": "window", "description": "Target of the ScrollTop." }, { @@ -16072,29 +19140,32 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Defines the threshold value of the vertical scroll position of the target to toggle the visibility.\nDefault value is 400." + "default": "400", + "description": "Defines the threshold value of the vertical scroll position of the target to toggle the visibility." } ], "methods": [] }, "ScrollTopSlots": { + "description": "Defines valid slots in ScrollTop component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ScrollTopEmits": { - "values": "{}" - } - } } }, - "selectbutton/SelectButton": { + "selectbutton": { + "description": "SelectButton is used to choose single or multiple items from a list using buttons.\n\n[Live Demo](https://www.primevue.org/selectbutton/)", + "components": { + "default": { + "description": "SelectButton is used to choose single or multiple items from a list using buttons.", + "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.", @@ -16104,7 +19175,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "SelectButtonChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "change", "props": [ { "name": "originalEvent", @@ -16125,7 +19197,66 @@ ], "methods": [] }, + "SelectButtonEmits": { + "description": "Defines valid emits in SelectButton component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on blur." + }, + { + "name": "change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "SelectButtonChangeEvent", + "description": "Custom change event." + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event" + } + ], + "returnType": "void", + "description": "Callback to invoke on focus." + }, + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] + }, "SelectButtonProps": { + "description": "Defines valid properties in SelectButton component.", "relatedProp": "", "props": [ { @@ -16149,7 +19280,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the element should be disabled." }, { @@ -16165,14 +19296,14 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When specified, allows selecting multiple values." }, { "name": "optionDisabled", "optional": true, "readonly": false, - "type": "SelectButtonOptionDisabledType", + "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." }, @@ -16180,7 +19311,7 @@ "name": "optionLabel", "optional": true, "readonly": false, - "type": "SelectButtonOptionLabelType", + "type": "string | Function", "default": "", "description": "Property name or getter function to use as the label of an option." }, @@ -16188,7 +19319,7 @@ "name": "optionValue", "optional": true, "readonly": false, - "type": "SelectButtonOptionValueType", + "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." }, @@ -16205,37 +19336,46 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "true", "description": "Whether selection can be cleared." } ], "methods": [] }, "SelectButtonSlots": { + "description": "Defines valid slots in SelectButton component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "option", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "option slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each option." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "SelectButtonEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"focus\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "sidebar/Sidebar": { + "sidebar": { + "description": "Sidebar is a panel component displayed as an overlay at the edges of the screen.\n\n- [Live Demo](https://primevue.org/sidebar)", + "components": { + "default": { + "description": "Sidebar is a panel component displayed as an overlay.", + "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.", @@ -16244,7 +19384,40 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -16252,23 +19425,23 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "blockScroll", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether background scroll should be blocked when sidebar is visible." }, { @@ -16276,31 +19449,31 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the sidebar close button.\nDefault value is 'pi pi-times'." + "default": "pi pi-times", + "description": "Icon to display in the sidebar close button." }, { "name": "dismissable", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether clicking outside closes the panel.\nDefault value is true." + "default": "true", + "description": "Whether clicking outside closes the panel." }, { "name": "modal", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to a modal layer behind the sidebar.\nDefault value is true." + "default": "true", + "description": "Whether to a modal layer behind the sidebar." }, { "name": "position", "optional": true, "readonly": false, - "type": "SidebarPositionType", - "default": "", + "type": "\"left\" | \"top\" | \"bottom\" | \"right\" | \"full\"", + "default": "left", "description": "Specifies the position of the sidebar." }, { @@ -16308,52 +19481,53 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to display a close icon inside the panel.\nDefault value is true." + "default": "true", + "description": "Whether to display a close icon inside the panel." }, { "name": "visible", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Specifies the visibility of the dialog." } ], "methods": [] }, "SidebarSlots": { + "description": "Defines valid slots in Sidebar component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "SidebarEmits": { - "values": "{\n \"hide\": \"Function, \",\n \"show\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "skeleton/Skeleton": { + "skeleton": { + "description": "Skeleton is a placeholder to display instead of the actual content.\n\n[Live Demo](https://www.primevue.org/skeleton/)", + "components": { + "default": { + "description": "Skeleton is a placeholder to display instead of the actual content.", + "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.", @@ -16362,15 +19536,22 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": "SkeletonAnimationType", - "default": "", + "type": "\"none\" | \"wave\"", + "default": "wave", "description": "Type of the animation." }, { @@ -16386,15 +19567,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Height of the element.\nDefault value is '1rem'." + "default": "1rem", + "description": "Height of the element." }, { "name": "shape", "optional": true, "readonly": false, - "type": "SkeletonShapeType", - "default": "", + "type": "\"circle\" | \"rectangle\"", + "default": "rectangle", "description": "Shape of the element." }, { @@ -16410,29 +19591,32 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Width of the element.\nDefault value is '100%'." + "default": "100%", + "description": "Width of the element." } ], "methods": [] }, "SkeletonSlots": { + "description": "Defines valid slots in Skeleton component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "SkeletonEmits": { - "values": "{}" - } - } } }, - "slider/Slider": { + "slider": { + "description": "Slider is a component to provide input with a drag handle.\n\n[Live Demo](https://www.primevue.org/slider/)", + "components": { + "default": { + "description": "Slider is a component to provide input with a drag handle.", + "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.", @@ -16441,7 +19625,54 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "SliderEmits": { + "description": "Defines valid emits in Slider component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value" + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "slideend", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "SliderSlideEndEvent", + "description": "Custom slide end event." + } + ], + "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": [ { @@ -16465,7 +19696,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -16473,16 +19704,16 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Maximum boundary value.\nDefault value is 100." + "default": "100", + "description": "Maximum boundary value." }, { "name": "min", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Mininum boundary value.\nDefault value is 0." + "default": "0", + "description": "Mininum boundary value." }, { "name": "modelValue", @@ -16490,14 +19721,14 @@ "readonly": false, "type": "number | number[]", "default": "", - "description": "Value of the component.\nDefault value is 0." + "description": "Value of the component." }, { "name": "orientation", "optional": true, "readonly": false, - "type": "SliderOrientationType", - "default": "", + "type": "\"horizontal\" | \"vertical\"", + "default": "horizontal", "description": "Orientation of the slider." }, { @@ -16505,7 +19736,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When speficed, allows two boundary values to be picked." }, { @@ -16513,8 +19744,8 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Step factor to increment/decrement the value.\nDefault value is 1." + "default": "1", + "description": "Step factor to increment/decrement the value." }, { "name": "tabindex", @@ -16528,7 +19759,8 @@ "methods": [] }, "SliderSlideEndEvent": { - "relatedProp": "", + "description": "Custom slide end event.", + "relatedProp": "slideend", "props": [ { "name": "originalEvent", @@ -16550,22 +19782,25 @@ "methods": [] }, "SliderSlots": { + "description": "Defines valid slots in Slider component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "SliderEmits": { - "values": "{\n \"change\": \"Function, \",\n \"slideend\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, - "speeddial/SpeedDial": { + "speeddial": { + "description": "When pressed, a floating action button can display multiple primary actions that can be performed on a page.\n\n[Live Demo](https://www.primevue.org/speeddial/)", + "components": { + "default": { + "description": "When pressed, a floating action button can display multiple primary actions that can be performed on a page.", + "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.", @@ -16574,7 +19809,66 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": [ { @@ -16613,8 +19907,8 @@ "name": "direction", "optional": true, "readonly": false, - "type": "SpeedDialDirectionType", - "default": "", + "type": "\"left\" | \"right\" | \"up\" | \"down\" | \"up-left\" | \"up-right\" | \"down-left\" | \"down-right\"", + "default": "up", "description": "Specifies the opening direction of actions." }, { @@ -16622,7 +19916,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the component is disabled." }, { @@ -16638,15 +19932,15 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether the actions close when clicked outside.\nDefault value is true." + "default": "true", + "description": "Whether the actions close when clicked outside." }, { "name": "mask", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to show a mask element behind the speeddial." }, { @@ -16678,24 +19972,24 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Radius for *circle types.\nDefault value is 0." + "default": "0", + "description": "Radius for *circle types." }, { "name": "rotateAnimation", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Defined to rotate showIcon when hideIcon is not present.\nDefault value is true." + "default": "true", + "description": "Defined to rotate showIcon when hideIcon is not present." }, { "name": "showIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Show icon of the button element.\nDefault value is 'pi pi-plus'." + "default": "pi pi-plus", + "description": "Show icon of the button element." }, { "name": "style", @@ -16718,15 +20012,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Transition delay step for each action item.\nDefault value is 30." + "default": "30", + "description": "Transition delay step for each action item." }, { "name": "type", "optional": true, "readonly": false, - "type": "SpeedDialType", - "default": "", + "type": "\"linear\" | \"circle\" | \"semi-circle\" | \"quarter-circle\"", + "default": "linear", "description": "Specifies the opening type of actions." }, { @@ -16734,40 +20028,54 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Specifies the visibility of the overlay." } ], "methods": [] }, "SpeedDialSlots": { + "description": "Defines valid slots in SpeedDial component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "button", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "button slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom button template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each item." } - ], - "methods": [] + ] }, "SpeedDialTooltipOptions": { - "relatedProp": "", + "description": "Defines tooltip options.", + "relatedProp": "tooltipOptions", "props": [ { "name": "event", "optional": false, "readonly": false, - "type": "string", + "type": "undefined | \"focus\" | \"hover\"", "default": "", "description": "Event to show the tooltip, valid values are hover and focus." }, @@ -16775,31 +20083,33 @@ "name": "position", "optional": false, "readonly": false, - "type": "string", + "type": "undefined | \"left\" | \"top\" | \"bottom\" | \"right\"", "default": "", - "description": "Position of element." + "description": "Position of element.\nDefault value is 'bottom'." }, { "name": "[key: string]", "optional": false, "readonly": false, - "type": "string" + "type": "any" } ], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "SpeedDialEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"click\": \"Function, \",\n \"focus\": \"Function, \",\n \"hide\": \"Function, \",\n \"show\": \"Function, \"\n}" - } - } } }, - "splitbutton/SplitButton": { + "splitbutton": { + "description": "SplitButton groups a set of commands in an overlay with a default command.\n\n[Live Demo](https://www.primevue.org/splitbutton/)", + "components": { + "default": { + "description": "SplitButton groups a set of commands in an overlay with a default command.", + "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.", @@ -16808,32 +20118,53 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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", "optional": true, "readonly": false, - "type": "SplitButtonAppendToType", - "default": "", - "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." + "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": "autoZIndex", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "buttonProps", @@ -16856,7 +20187,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the element should be disabled." }, { @@ -16911,25 +20242,17 @@ "methods": [] }, "SplitButtonSlots": { + "description": "Defines valid slots in SplitButton component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Button part of the content can easily be customized with the default slot instead of using the built-in modes." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "SplitButtonEmits": { - "values": "{\n \"click\": \"Function, \"\n}" + ] } } } @@ -16937,7 +20260,7 @@ "splitter": { "description": "Splitter is utilized to separate and resize panels.\n\n[Live Demo](https://www.primevue.org/splitter/)", "components": { - "Splitter": { + "default": { "description": "Splitter is utilized to separate and resize panels.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -17098,7 +20421,7 @@ "splitterpanel": { "description": "SplitterPanel is a helper component for Splitter component.\n\n[Live Demo](https://www.primevue.org/splitter/)", "components": { - "SplitterPanel": { + "default": { "description": "SplitterPanel is a helper component for Splitter component.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", @@ -17159,7 +20482,17 @@ } } }, - "steps/Steps": { + "steps": { + "description": "Steps components is an indicator for the steps in a wizard workflow. Example below uses nested routes with Steps.\n\n[Live Demo](https://www.primevue.org/steps/)", + "components": { + "default": { + "description": "Steps components is an indicator for the steps in a wizard workflow. Example below uses nested routes with Steps.", + "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.", @@ -17168,7 +20501,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "StepsEmits": { + "description": "Defines valid emits in Steps component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "StepsProps": { + "description": "Defines valid properties in Steps component.", "relatedProp": "", "props": [ { @@ -17176,8 +20516,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.\nDefault value is true." + "default": "true", + "description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path." }, { "name": "id", @@ -17200,38 +20540,154 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether the items are clickable or not.\nDefault value is true." + "default": "true", + "description": "Whether the items are clickable or not." } ], "methods": [] }, "StepsSlots": { + "description": "Defines valid slots in Steps component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "item", + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." + } + ] + } + } + } + }, + "styleclass": { + "description": "StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element.\n\n- [Live Demo](https://primevue.org/styleclass)", + "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.", + "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", + "slotDescription": "Defines the slots used by the component.", + "values": { + "StyleClassDirectiveBinding": { + "description": "Binding of StyleClass directive.", "relatedProp": "", "props": [ { - "name": "item", - "optional": false, + "name": "value", + "optional": true, "readonly": false, - "type": "Function", - "default": "" + "type": "StyleClassOptions", + "default": "", + "description": "Value of the StyleClass." + } + ], + "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": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "StepsEmits": { - "values": "{}" - } - } } }, - "styleclass/StyleClass": {}, - "tabmenu/TabMenu": { + "tabmenu": { + "description": "TabMenu is a navigation component that displays items as tab headers. Example below uses nested routes with TabMenu.\n\n[Live Demo](https://www.primevue.org/tabmenu/)", + "components": { + "default": { + "description": "TabMenu is a navigation component that displays items as tab headers. Example below uses nested routes with TabMenu.", + "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.", @@ -17241,7 +20697,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "TabMenuChangeEvent": { - "relatedProp": "", + "description": "Custom change event.", + "relatedProp": "['tab-change']", "props": [ { "name": "index", @@ -17262,7 +20719,28 @@ ], "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": [ { @@ -17270,8 +20748,8 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Active index of menuitem.\nDefault value is 0." + "default": "0", + "description": "Active index of menuitem." }, { "name": "aria-label", @@ -17294,8 +20772,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Defines if active route highlight should match the exact route path.\nDefault value is true." + "default": "true", + "description": "Defines if active route highlight should match the exact route path." }, { "name": "model", @@ -17309,30 +20787,39 @@ "methods": [] }, "TabMenuSlots": { + "description": "Defines valid slots in TabMenu component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content for each item." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TabMenuEmits": { - "values": "{\n \"tab-change\": \"Function, \"\n}" + ] } } } }, - "tabpanel/TabPanel": { + "tabpanel": { + "description": "TabPanel is a helper component for TabPanel component.\n\n[Live Demo](https://www.primevue.org/tabview/)", + "components": { + "default": { + "description": "TabPanel is a helper component for TabPanel component.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -17341,7 +20828,13 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "TabPanelEmits": { + "relatedProp": "", + "props": [], + "methods": [] + }, "TabPanelProps": { + "description": "Defines valid properties in TabPanel component.", "relatedProp": "", "props": [ { @@ -17373,7 +20866,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the tab is disabled." }, { @@ -17420,6 +20913,7 @@ "methods": [] }, "TabPanelSlots": { + "description": "Defines valid slots in TabPanel slots.", "relatedProp": "", "props": [ { @@ -17440,17 +20934,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TabPanelEmits": { - "values": "{}" - } - } } }, - "tabview/TabView": { + "tabview": { + "description": "TabView is a container component to group content with tabs.\n\n[Live Demo](https://www.primevue.org/tabview/)", + "components": { + "default": { + "description": "TabView is a container component to group content with tabs.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -17460,7 +20956,8 @@ "slotDescription": "Defines the slots used by the component.", "values": { "TabViewChangeEvent": { - "relatedProp": "", + "description": "Custom tab change event.", + "relatedProp": "tab-change", "props": [ { "name": "index", @@ -17483,8 +20980,8 @@ "extendedBy": "TabViewClickEvent" }, "TabViewClickEvent": { - "description": "", - "relatedProp": "", + "description": "Custom tab change event.", + "relatedProp": "tab-click", "props": [ { "name": "index", @@ -17506,7 +21003,54 @@ "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." + } + ] + }, "TabViewProps": { + "description": "Defines valid properties in TabView component.", "relatedProp": "", "props": [ { @@ -17514,7 +21058,7 @@ "optional": true, "readonly": false, "type": "number", - "default": "", + "default": "0", "description": "Index of the active tab." }, { @@ -17522,7 +21066,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css." }, { @@ -17546,7 +21090,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled displays buttons at each side of the tab headers to scroll the tab list." }, { @@ -17554,7 +21098,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled, the focused tab is activated." }, { @@ -17562,37 +21106,39 @@ "optional": true, "readonly": false, "type": "number", - "default": "", + "default": "0", "description": "Index of the element in tabbing order." } ], "methods": [] }, "TabViewSlots": { + "description": "Defines valid slots in TabView slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Default slot to detect TabPanel components." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TabViewEmits": { - "values": "{\n \"tab-change\": \"Function, \",\n \"tab-click\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "tag/Tag": { + "tag": { + "description": "Tag component is used to categorize content.\n\n[Live Demo](https://www.primevue.org/tag)", + "components": { + "default": { + "description": "Tag component is used to categorize content.", + "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.", @@ -17601,7 +21147,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "TagEmits": { + "description": "Defines valid emits in Tag component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "TagProps": { + "description": "Defines valid properties in Tag component.", "relatedProp": "", "props": [ { @@ -17617,14 +21170,14 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the corners of the tag are rounded." }, { "name": "severity", "optional": true, "readonly": false, - "type": "TagSeverityType", + "type": "\"success\" | \"info\" | \"warning\" | \"danger\"", "default": "", "description": "Severity type of the tag." }, @@ -17640,30 +21193,32 @@ "methods": [] }, "TagSlots": { + "description": "Defines valid slots in Tag component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "default", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template" } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TagEmits": { - "values": "{}" + ] } } } }, - "terminal/Terminal": { + "terminal": { + "description": "Terminal is a text based user interface.\n\n[Live Demo](https://www.primevue.org/terminal)", + "components": { + "default": { + "description": "Terminal is a text based user interface.", + "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.", @@ -17672,7 +21227,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "TerminalEmits": { + "description": "Defines valid emits in Terminal component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "TerminalProps": { + "description": "Defines valid properties in Terminal component.", "relatedProp": "", "props": [ { @@ -17695,19 +21257,12 @@ "methods": [] }, "TerminalSlots": { + "description": "Defines valid slots in Terminal component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TerminalEmits": { - "values": "{}" - } - } } }, "terminalservice/TerminalService": { @@ -17776,7 +21331,17 @@ } } }, - "textarea/Textarea": { + "textarea": { + "description": "Textarea is a multi-line text input element.\n\n[Live Demo](https://www.primevue.org/textarea/)", + "components": { + "default": { + "description": "Textarea is a multi-line text input element.", + "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.", @@ -17785,7 +21350,22 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "TextareaEmits": { + "description": "Defines valid emits in Textarea component.", + "relatedProp": "", + "props": [ + { + "name": "update:modelValue", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + } + ], + "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": [ { @@ -17809,19 +21389,12 @@ "extendedTypes": "TextareaHTMLAttributes" }, "TextareaSlots": { + "description": "Defines valid slots in Textarea component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TextareaEmits": { - "values": "{\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, "tieredmenu/TieredMenu": { @@ -17943,7 +21516,17 @@ } } }, - "timeline/Timeline": { + "timeline": { + "description": "Timeline visualizes a series of chained events.\n\n- [Live Demo](https://primevue.org/timeline)", + "components": { + "default": { + "description": "Timeline visualizes a series of chained events.", + "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.", @@ -17952,15 +21535,22 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "TimelineEmits": { + "description": "Defines valid emits in Timeline component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "TimelineProps": { + "description": "Defines valid properties in Timeline component.", "relatedProp": "", "props": [ { "name": "align", "optional": true, "readonly": false, - "type": "TimelineAlignType", - "default": "", + "type": "\"alternate\" | \"left\" | \"top\" | \"bottom\" | \"right\"", + "default": "left", "description": "Position of the timeline bar relative to the content." }, { @@ -17975,8 +21565,8 @@ "name": "layout", "optional": true, "readonly": false, - "type": "TimelineLayoutType", - "default": "", + "type": "\"horizontal\" | \"vertical\"", + "default": "horizontal", "description": "Orientation of the timeline." }, { @@ -17991,51 +21581,77 @@ "methods": [] }, "TimelineSlots": { + "description": "Defines valid slots in Timeline component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "connector", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object" + } + ], + "returnType": "VNode[]", + "description": "Custom connector template." }, { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "content slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content template" }, { "name": "marker", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "marker slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom marker template." }, { "name": "opposite", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "opposite slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom opposite template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TimelineEmits": { - "values": "{}" + ] } } } }, - "toast/Toast": { + "toast": { + "description": "Toast is used to display messages in an overlay.\n\n[Live Demo](https://www.primevue.org/toast/)", + "components": { + "default": { + "description": "Toast is used to display messages in an overlay.", + "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.", @@ -18056,6 +21672,11 @@ ], "methods": [] }, + "ToastEmits": { + "relatedProp": "", + "props": [], + "methods": [] + }, "ToastMessageOptions": { "relatedProp": "", "props": [ @@ -18103,9 +21724,9 @@ "name": "severity", "optional": true, "readonly": false, - "type": "any", + "type": "\"error\" | \"success\" | \"info\" | \"warn\"", "default": "", - "description": "Severity level of the message." + "description": "Severity level of the message.\nDefault value is 'info'." }, { "name": "styleClass", @@ -18127,6 +21748,7 @@ "methods": [] }, "ToastProps": { + "description": "Defines valid properties in Toast component.", "relatedProp": "", "props": [ { @@ -18134,16 +21756,16 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to automatically manage layering.\nDefault value is true." + "default": "true", + "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Base zIndex value to use in layering.\nDefault value is 0." + "default": "0", + "description": "Base zIndex value to use in layering." }, { "name": "breakpoints", @@ -18166,16 +21788,16 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the toast close button.\nDefault value is 'pi pi-times'." + "default": "pi pi-times", + "description": "Icon to display in the toast close button." }, { "name": "errorIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the toast with error severity.\nDefault value is 'pi pi-times'." + "default": "pi pi-times", + "description": "Icon to display in the toast with error severity." }, { "name": "group", @@ -18190,15 +21812,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the toast with info severity.\nDefault value is 'pi pi-info-circle'." + "default": "pi pi-info-circle", + "description": "Icon to display in the toast with info severity." }, { "name": "position", "optional": true, "readonly": false, - "type": "ToastPositionType", - "default": "", + "type": "\"center\" | \"top-left\" | \"top-center\" | \"top-right\" | \"bottom-left\" | \"bottom-center\" | \"bottom-right\"", + "default": "top-right", "description": "Position of the toast in viewport." }, { @@ -18206,40 +21828,38 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the toast with success severity.\nDefault value is 'pi pi-check'." + "default": "pi pi-check", + "description": "Icon to display in the toast with success severity." }, { "name": "warnIcon", "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display in the toast with warn severity.\nDefault value is 'pi pi-exclamation-triangle'." + "default": "pi pi-exclamation-triangle", + "description": "Icon to display in the toast with warn severity." } ], "methods": [] }, "ToastSlots": { "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "message", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "message slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom message template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ToastEmits": { - "values": "{}" + ] } } } @@ -18283,7 +21903,17 @@ } } }, - "togglebutton/ToggleButton": { + "togglebutton": { + "description": "ToggleButton is used to select a boolean value using a button.\n\n[Live Demo](https://www.primevue.org/togglebutton/)", + "components": { + "default": { + "description": "ToggleButton is used to select a boolean value using a button.", + "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.", @@ -18292,7 +21922,67 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ToggleButtonEmits": { + "description": "Defines valid emits in ToggleButton 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": "Event", + "description": "Browser 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": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] + }, "ToggleButtonProps": { + "description": "Defines valid properties in ToggleButton component.", "relatedProp": "", "props": [ { @@ -18316,15 +22006,15 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the element should be disabled." }, { "name": "iconPos", "optional": true, "readonly": false, - "type": "ToggleButtonType", - "default": "", + "type": "\"left\" | \"right\"", + "default": "left", "description": "Position of the icon." }, { @@ -18364,7 +22054,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Value of the component." }, { @@ -18380,8 +22070,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Label for the off state.\nDefault value is 'no'." + "default": "no", + "description": "Label for the off state." }, { "name": "onIcon", @@ -18396,8 +22086,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Label for the on state.\nDefault value is 'yes'." + "default": "yes", + "description": "Label for the on state." }, { "name": "tabindex", @@ -18411,22 +22101,25 @@ "methods": [] }, "ToggleButtonSlots": { + "description": "Defines valid slots in ToggleButton component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ToggleButtonEmits": { - "values": "{\n \"blur\": \"Function, \",\n \"change\": \"Function, \",\n \"focus\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, - "toolbar/Toolbar": { + "toolbar": { + "description": "Toolbar is a grouping component for buttons and other content.\n\n[Live Demo](https://www.primevue.org/toolbar/)", + "components": { + "default": { + "description": "Toolbar is a grouping component for buttons and other content.", + "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.", @@ -18435,7 +22128,14 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "ToolbarEmits": { + "description": "Defines valid emits in Toolbar component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "ToolbarProps": { + "description": "Defines valid properties in Toolbar component.", "relatedProp": "", "props": [ { @@ -18450,45 +22150,35 @@ "methods": [] }, "ToolbarSlots": { + "description": "Defines valid slots in Toolbar slots.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "center", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom center template." }, { "name": "end", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom end template." }, { "name": "start", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom start template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ToolbarEmits": { - "values": "{}" + ] } } } }, - "tooltip/Tooltip": {}, - "tree/Tree": { + "tooltip": { + "description": "Tooltip directive provides advisory information for a component.\n\n- [Live Demo](https://primevue.org/tooltip)", "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -18497,7 +22187,240 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": "string", + "default": "false", + "description": "Bottom position for Tooltip." + }, + { + "name": "focus", + "optional": true, + "readonly": false, + "type": "string", + "default": "true", + "description": "Focus event for Tooltip." + }, + { + "name": "left", + "optional": true, + "readonly": false, + "type": "string", + "default": "false", + "description": "Left position for Tooltip." + }, + { + "name": "right", + "optional": true, + "readonly": false, + "type": "string", + "default": "true", + "description": "Right position for Tooltip." + }, + { + "name": "top", + "optional": true, + "readonly": false, + "type": "string", + "default": "false", + "description": "Top position for Tooltip." + } + ], + "methods": [] + }, + "TooltipOptions": { + "description": "Defines options of Tooltip.", + "relatedProp": "", + "props": [ + { + "name": "class", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "When present, it adds a custom class to the tooltip." + }, + { + "name": "disabled", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should be disabled." + }, + { + "name": "escape", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it adds a custom id to the tooltip." + }, + { + "name": "fitContent", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Automatically adjusts the element position when there is not enough space on the selected position." + }, + { + "name": "id", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "When present, it adds a custom id to the tooltip." + }, + { + "name": "value", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Text of the tooltip." + } + ], + "methods": [] + } + } + } + }, + "tree": { + "description": "Tree is used to display hierarchical data.\n\n[Live Demo](https://www.primevue.org/tree/)", + "components": { + "default": { + "description": "Tree is used to display 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.", + "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", + "slotDescription": "Defines the slots used by the component.", + "values": { + "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": [ + { + "name": "value", + "optional": false, + "type": "TreeExpandedKeys", + "description": "New expanded keys." + } + ], + "returnType": "void", + "description": "Emitted when the expanded keys change." + }, + { + "name": "update:selectionKeys", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "TreeSelectionKeys" + } + ], + "returnType": "void", + "description": "Emitted when the selection keys change." + } + ] + }, "TreeExpandedKeys": { + "description": "Custom expanded keys metadata.", "relatedProp": "", "props": [ { @@ -18510,6 +22433,7 @@ "methods": [] }, "TreeNode": { + "description": "Custom TreeNode metadata.", "relatedProp": "", "props": [ { @@ -18618,6 +22542,7 @@ "methods": [] }, "TreeProps": { + "description": "Defines valid properties in Tree component.", "relatedProp": "", "props": [ { @@ -18672,8 +22597,8 @@ "name": "filterMode", "optional": true, "readonly": false, - "type": "TreeFilterModeType", - "default": "", + "type": "\"strict\" | \"lenient\"", + "default": "lenient", "description": "Mode for filtering." }, { @@ -18689,7 +22614,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to display loading indicator." }, { @@ -18697,22 +22622,22 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Icon to display when tree is loading.\nDefault value is 'pi pi-spin'." + "default": "pi pi-spin", + "description": "Icon to display when tree is loading." }, { "name": "metaKeySelection", "optional": true, "readonly": false, "type": "boolean", - "default": "", - "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.\nDefault value is true." + "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": "TreeScrollHeightType", + "type": "string", "default": "", "description": "Height of the scroll viewport in fixed units or the 'flex' keyword for a dynamic size." }, @@ -18728,7 +22653,7 @@ "name": "selectionMode", "optional": true, "readonly": false, - "type": "TreeSelectionModeType", + "type": "\"multiple\" | \"checkbox\" | \"single\"", "default": "", "description": "Defines the selection mode." }, @@ -18744,6 +22669,7 @@ "methods": [] }, "TreeSelectionKeys": { + "description": "Custom selection keys metadata.", "relatedProp": "", "props": [ { @@ -18756,29 +22682,25 @@ "methods": [] }, "TreeSlots": { + "description": "Defines valid slots in Tree component.", "relatedProp": "", - "props": [ - { - "name": "[key: string]", - "optional": false, - "readonly": false, - "type": "Function" - } - ], + "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TreeEmits": { - "values": "{\n \"node-collapse\": \"Function, \",\n \"node-expand\": \"Function, \",\n \"node-select\": \"Function, \",\n \"node-unselect\": \"Function, \",\n \"update:expandedKeys\": \"Function, \",\n \"update:selectionKeys\": \"Function, \"\n}" - } - } } }, - "treeselect/TreeSelect": { + "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.", @@ -18787,16 +22709,126 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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", + "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": "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." + } + ] + }, "TreeSelectProps": { + "description": "Defines valid properties in TreeSelect component.", "relatedProp": "", "props": [ { "name": "appendTo", "optional": true, "readonly": false, - "type": "TreeSelectAppendToType", - "default": "", - "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": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { "name": "aria-label", @@ -18819,15 +22851,15 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { "name": "display", "optional": true, "readonly": false, - "type": "TreeSelectDisplayType", - "default": "", + "type": "\"comma\" | \"chip\"", + "default": "comma", "description": "Defines how the selected items are displayed." }, { @@ -18835,8 +22867,8 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.\nDefault value is 'No results found'." + "default": "No results found", + "description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration." }, { "name": "inputClass", @@ -18858,9 +22890,9 @@ "name": "inputProps", "optional": true, "readonly": false, - "type": "object", + "type": "InputHTMLAttributes", "default": "", - "description": "" + "description": "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." }, { "name": "inputStyle", @@ -18875,8 +22907,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "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.\nDefault value is true." + "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", @@ -18915,14 +22947,14 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value.\nDefault value is '200px'." + "default": "200px", + "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." }, { "name": "selectionMode", "optional": true, "readonly": false, - "type": "TreeSelectSelectionModeType", + "type": "\"multiple\" | \"checkbox\" | \"single\"", "default": "", "description": "Defines the selection mode." }, @@ -18938,58 +22970,77 @@ "methods": [] }, "TreeSelectSlots": { + "description": "Defines valid slots in TreeSelect component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "footer slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "indicator", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom indicator template." }, { "name": "value", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "value slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom value template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TreeSelectEmits": { - "values": "{\n \"before-hide\": \"Function, \",\n \"before-show\": \"Function, \",\n \"change\": \"Function, \",\n \"hide\": \"Function, \",\n \"node-collapse\": \"Function, \",\n \"node-expand\": \"Function, \",\n \"node-select\": \"Function, \",\n \"node-unselect\": \"Function, \",\n \"show\": \"Function, \",\n \"update:modelValue\": \"Function, \"\n}" + ] } } } }, - "treetable/TreeTable": { + "treetable": { + "description": "TreeTable is used to display hierarchical data in tabular format.\n\n[Live Demo](https://www.primevue.org/treetable/)", + "components": { + "default": { + "description": "TreeTable is used to display hierarchical data in tabular format.", + "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.", @@ -18998,7 +23049,209 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "TreeTableEmits": { + "description": "Defines valid emits in TreeTable component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "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." + }, + { + "name": "filter", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "TreeTableFilterEvent", + "description": "Custom filter event." + } + ], + "returnType": "void", + "description": "Event to emit after filtering, not triggered in lazy mode." + }, + { + "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": "page", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "TreeTablePageEvent", + "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": "TreeTableSortEvent", + "description": "Custom sort event." + } + ], + "returnType": "void", + "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", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "TreeTableSelectionKeys" + } + ], + "returnType": "void", + "description": "Emitted when the selection keys change." + }, + { + "name": "update:sortField", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the sortField changes." + }, + { + "name": "update:sortOrder", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "undefined | number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the sortOrder changes." + } + ] + }, "TreeTableExpandedKeys": { + "description": "Custom expanded keys metadata.", "relatedProp": "", "props": [ { @@ -19011,14 +23264,14 @@ "methods": [] }, "TreeTableFilterEvent": { - "description": "", - "relatedProp": "", + "description": "Custom filter event.", + "relatedProp": "sort", "props": [ { "name": "filterMatchModes", "optional": false, "readonly": false, - "type": "TreeTableFilterMatchModeType", + "type": "undefined | \"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\"", "default": "", "description": "Match modes per field" }, @@ -19050,7 +23303,7 @@ "name": "multiSortMeta", "optional": false, "readonly": false, - "type": "TreeTableMultiSortMetaType", + "type": "undefined | null | TreeTableSortMeta[]", "default": "", "description": "MultiSort metadata" }, @@ -19074,7 +23327,7 @@ "name": "sortField", "optional": false, "readonly": false, - "type": "TreeTableSortFieldType", + "type": "undefined | string | Function", "default": "", "description": "Field to sort against" }, @@ -19082,7 +23335,7 @@ "name": "sortOrder", "optional": false, "readonly": false, - "type": "TreeTableSortOrderType", + "type": "undefined | null | 0 | 1 | -1", "default": "", "description": "Sort order as integer" } @@ -19091,6 +23344,7 @@ "extendedTypes": "TreeTableSortEvent" }, "TreeTableFilterMeta": { + "description": "Custom filter metadata.", "relatedProp": "", "props": [ { @@ -19103,13 +23357,14 @@ "methods": [] }, "TreeTableFilterMetaData": { + "description": "Custom treetable filter metadata.", "relatedProp": "", "props": [ { "name": "matchMode", "optional": false, "readonly": false, - "type": "TreeTableFilterMatchModeType", + "type": "undefined | \"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\"", "default": "", "description": "Filter match mode" }, @@ -19125,6 +23380,7 @@ "methods": [] }, "TreeTableOperatorFilterMetaData": { + "description": "Custom operator filter metadata.", "relatedProp": "", "props": [ { @@ -19147,14 +23403,14 @@ "methods": [] }, "TreeTablePageEvent": { - "description": "", - "relatedProp": "", + "description": "Custom page event.", + "relatedProp": "sort", "props": [ { "name": "filterMatchModes", "optional": false, "readonly": false, - "type": "TreeTableFilterMatchModeType", + "type": "undefined | \"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\"", "default": "", "description": "Match modes per field" }, @@ -19178,7 +23434,7 @@ "name": "multiSortMeta", "optional": false, "readonly": false, - "type": "TreeTableMultiSortMetaType", + "type": "undefined | null | TreeTableSortMeta[]", "default": "", "description": "MultiSort metadata" }, @@ -19218,7 +23474,7 @@ "name": "sortField", "optional": false, "readonly": false, - "type": "TreeTableSortFieldType", + "type": "undefined | string | Function", "default": "", "description": "Field to sort against" }, @@ -19226,7 +23482,7 @@ "name": "sortOrder", "optional": false, "readonly": false, - "type": "TreeTableSortOrderType", + "type": "undefined | null | 0 | 1 | -1", "default": "", "description": "Sort order as integer" } @@ -19235,6 +23491,7 @@ "extendedTypes": "TreeTableSortEvent" }, "TreeTableProps": { + "description": "Defines valid properties in TreeTable component.", "relatedProp": "", "props": [ { @@ -19242,23 +23499,23 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Whether to show it even there is only one page.\nDefault value is true." + "default": "true", + "description": "Whether to show it even there is only one page." }, { "name": "autoLayout", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether the cell widths scale according to their content or not." }, { "name": "columnResizeMode", "optional": true, "readonly": false, - "type": "TreeTableColumnResizeModeType", - "default": "", + "type": "\"fit\" | \"expand\"", + "default": "fit", "description": "Defines whether the overall table width should change on column resize." }, { @@ -19266,16 +23523,16 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Template of the current page report element. It displays information about the pagination state. Default value is ({currentPage} of {totalPages}) whereas available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" + "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": "", - "description": "Default sort order of an unsorted column.\nDefault value is 1." + "default": "1", + "description": "Default sort order of an unsorted column." }, { "name": "expandedKeys", @@ -19297,8 +23554,8 @@ "name": "filterMode", "optional": true, "readonly": false, - "type": "TreeTableFilterModeType", - "default": "", + "type": "\"strict\" | \"lenient\"", + "default": "lenient", "description": "Mode for filtering." }, { @@ -19314,23 +23571,23 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Index of the first row to be displayed.\nDefault value is 0." + "default": "0", + "description": "Index of the first row to be displayed." }, { "name": "indentation", "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Indentation factor as rem value for children nodes.\nDefault value is 1." + "default": "1", + "description": "Indentation factor as rem value for children nodes." }, { "name": "lazy", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines if data is loaded and interacted with in lazy manner." }, { @@ -19338,7 +23595,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Displays a loader to indicate data load is in progress." }, { @@ -19346,22 +23603,22 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "The icon to show while indicating data load is in progress.\nDefault value is 'pi pi-spinner'." + "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": "", - "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.\nDefault value is true." + "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": "TreeTableMultiSortMetaType", + "type": "null | TreeTableSortMeta[]", "default": "", "description": "An array of SortMeta objects to sort the data by default in multiple sort mode." }, @@ -19370,8 +23627,8 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Number of page links to display.\nDefault value is 5." + "default": "5", + "description": "Number of page links to display." }, { "name": "paginator", @@ -19385,8 +23642,8 @@ "name": "paginatorPosition", "optional": true, "readonly": false, - "type": "TreeTablePaginatorPositionType", - "default": "", + "type": "\"both\" | \"top\" | \"bottom\"", + "default": "bottom", "description": "Position of the paginator, options are 'top','bottom' or 'both'." }, { @@ -19394,15 +23651,15 @@ "optional": true, "readonly": false, "type": "string", - "default": "", - "description": "Template of the paginator. It can be customized using the template property using the predefined keys, default value is 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown'. 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" + "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": "", + "default": "false", "description": "When enabled, columns can have an un-sorted state." }, { @@ -19417,8 +23674,8 @@ "name": "responsiveLayout", "optional": true, "readonly": false, - "type": "TreeTableResponsiveLayoutType", - "default": "", + "type": "\"scroll\" | \"stack\"", + "default": "stack", "description": "Defines the responsive mode, currently only option is scroll." }, { @@ -19426,7 +23683,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When enabled, background of the rows change on hover." }, { @@ -19449,15 +23706,15 @@ "name": "scrollDirection", "optional": true, "readonly": false, - "type": "TreeTableScrollDirectionType", - "default": "", + "type": "\"both\" | \"horizontal\" | \"vertical\"", + "default": "vertical", "description": "Orientation of the scrolling." }, { "name": "scrollHeight", "optional": true, "readonly": false, - "type": "TreeTableScrollHeightType", + "type": "string", "default": "", "description": "Height of the scroll viewport in fixed pixels or the 'flex' keyword for a dynamic size." }, @@ -19466,7 +23723,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When specified, enables horizontal and/or vertical scrolling." }, { @@ -19481,7 +23738,7 @@ "name": "selectionMode", "optional": true, "readonly": false, - "type": "TreeTableSelectionModeType", + "type": "\"multiple\" | \"checkbox\" | \"single\"", "default": "", "description": "Defines the selection mode." }, @@ -19490,14 +23747,14 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to show grid lines between cells." }, { "name": "sortField", "optional": true, "readonly": false, - "type": "TreeTableSortFieldType", + "type": "string | Function", "default": "", "description": "Property name or a getter function of a row data used for sorting by default." }, @@ -19505,8 +23762,8 @@ "name": "sortMode", "optional": true, "readonly": false, - "type": "TreeTableSortModeType", - "default": "", + "type": "\"multiple\" | \"single\"", + "default": "single", "description": "Defines whether sorting works on single column or on multiple columns." }, { @@ -19545,6 +23802,7 @@ "methods": [] }, "TreeTableSelectionKeys": { + "description": "Custom selection keys metadata.", "relatedProp": "", "props": [ { @@ -19557,54 +23815,51 @@ "methods": [] }, "TreeTableSlots": { + "description": "Defines valid slots in TreeTable component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "empty", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom empty template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "paginatorend", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator end template." }, { "name": "paginatorstart", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom paginator start template." } - ], - "methods": [] + ] }, "TreeTableSortEvent": { - "relatedProp": "", + "description": "Custom sort event.", + "relatedProp": "sort", "props": [ { "name": "filterMatchModes", "optional": false, "readonly": false, - "type": "TreeTableFilterMatchModeType", + "type": "undefined | \"endsWith\" | \"startsWith\" | \"contains\" | \"in\" | \"notContains\" | \"equals\" | \"notEquals\" | \"lt\" | \"lte\" | \"gt\" | \"gte\" | \"between\" | \"dateIs\" | \"dateIsNot\" | \"dateBefore\" | \"dateAfter\"", "default": "", "description": "Match modes per field" }, @@ -19628,7 +23883,7 @@ "name": "multiSortMeta", "optional": false, "readonly": false, - "type": "TreeTableMultiSortMetaType", + "type": "undefined | null | TreeTableSortMeta[]", "default": "", "description": "MultiSort metadata" }, @@ -19652,7 +23907,7 @@ "name": "sortField", "optional": false, "readonly": false, - "type": "TreeTableSortFieldType", + "type": "undefined | string | Function", "default": "", "description": "Field to sort against" }, @@ -19660,7 +23915,7 @@ "name": "sortOrder", "optional": false, "readonly": false, - "type": "TreeTableSortOrderType", + "type": "undefined | null | 0 | 1 | -1", "default": "", "description": "Sort order as integer" } @@ -19669,6 +23924,7 @@ "extendedBy": "TreeTablePageEvent,TreeTableFilterEvent" }, "TreeTableSortMeta": { + "description": "Custom sort metadata.", "relatedProp": "", "props": [ { @@ -19683,7 +23939,7 @@ "name": "order", "optional": false, "readonly": false, - "type": "TreeTableSortOrderType", + "type": "undefined | null | 0 | 1 | -1", "default": "", "description": "Column sort order" } @@ -19691,17 +23947,19 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TreeTableEmits": { - "values": "{\n \"column-resize-end\": \"Function, \",\n \"filter\": \"Function, \",\n \"node-collapse\": \"Function, \",\n \"node-expand\": \"Function, \",\n \"node-select\": \"Function, \",\n \"node-unselect\": \"Function, \",\n \"page\": \"Function, \",\n \"sort\": \"Function, \",\n \"update:expandedKeys\": \"Function, \",\n \"update:first\": \"Function, \",\n \"update:multiSortMeta\": \"Function, \",\n \"update:rows\": \"Function, \",\n \"update:selectionKeys\": \"Function, \",\n \"update:sortField\": \"Function, \",\n \"update:sortOrder\": \"Function, \"\n}" - } - } } }, - "tristatecheckbox/TriStateCheckbox": { + "tristatecheckbox": { + "description": "TriStateCheckbox is used to select either 'true', 'false' or 'null' as the value.\n\n[Live Demo](https://www.primevue.org/tristatecheckbox/)", + "components": { + "default": { + "description": "TriStateCheckbox is used to select either 'true', 'false' or 'null' as the value.", + "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.", @@ -19710,7 +23968,28 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "values": { + "TriStateCheckboxEmits": { + "description": "Defines valid emits in TriStateCheckbox component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "Nullable", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] + }, "TriStateCheckboxProps": { + "description": "Defines valid properties in TriStateCheckbox component.", "relatedProp": "", "props": [ { @@ -19734,7 +24013,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "When present, it specifies that the component should be disabled." }, { @@ -19758,7 +24037,7 @@ "optional": true, "readonly": false, "type": "Nullable", - "default": "", + "default": "null", "description": "Value of the component." }, { @@ -19773,19 +24052,12 @@ "methods": [] }, "TriStateCheckboxSlots": { + "description": "Defines valid slots in TriStateCheckbox component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "TriStateCheckboxEmits": { - "values": "{\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, "ts-helpers": { @@ -19875,7 +24147,75 @@ } } }, - "virtualscroller/VirtualScroller": { + "virtualscroller": { + "description": "VirtualScroller is a performant approach to handle huge data efficiently.\n\n[Live Demo](https://www.primevue.org/virtualscroller/)", + "components": { + "default": { + "description": "VirtualScroller is a performant approach to handle huge data efficiently.", + "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": [ + { + "name": "options", + "type": "ScrollToOptions", + "description": "scoll options." + } + ], + "returnType": "void", + "description": "Scroll to move to a specific position." + }, + { + "name": "scrollToIndex", + "parameters": [ + { + "name": "index", + "type": "number", + "description": "Index of item according to orientation mode." + }, + { + "name": "behavior", + "type": "ScrollBehavior", + "description": "Behavior of scroll." + } + ], + "returnType": "void", + "description": "Scroll to move to a specific item." + } + ] + } + } + }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "eventDescription": "Defines the custom events used by the component's emit.", @@ -19884,7 +24224,67 @@ "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "slotDescription": "Defines the slots used by the component.", "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": "", "props": [ { @@ -19946,8 +24346,8 @@ "extendedBy": "VirtualScrollerLoaderOptions" }, "VirtualScrollerLazyEvent": { - "description": "", - "relatedProp": "", + "description": "Custom lazy event.", + "relatedProp": "scroll-index-change", "props": [ { "name": "first", @@ -19970,8 +24370,8 @@ "extendedTypes": "VirtualScrollerScrollIndexChangeEvent" }, "VirtualScrollerLoaderOptions": { - "description": "", - "relatedProp": "", + "description": "Custom virtualscroller loader options", + "relatedProp": "VirtualScrollerItemOptions", "props": [ { "name": "count", @@ -20027,6 +24427,7 @@ "extendedTypes": "VirtualScrollerItemOptions" }, "VirtualScrollerProps": { + "description": "Defines valid properties in VirtualScroller component.", "relatedProp": "", "props": [ { @@ -20058,15 +24459,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "description": "Delay in scroll before new data is loaded.\nDefault value is 0." + "default": "0", + "description": "Delay in scroll before new data is loaded." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "If disabled, the VirtualScroller feature is eliminated and the content is displayed directly." }, { @@ -20089,7 +24490,7 @@ "name": "itemSize", "optional": true, "readonly": false, - "type": "VirtualScrollerItemSizeType", + "type": "number | number[]", "default": "", "description": "The height/width of item according to orientation." }, @@ -20097,7 +24498,7 @@ "name": "items", "optional": true, "readonly": false, - "type": "VirtualScrollerItemsType", + "type": "null | any[] | any[][]", "default": "", "description": "An array of objects to display." }, @@ -20106,7 +24507,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Defines if data is loaded and interacted with in lazy manner." }, { @@ -20114,7 +24515,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Used to implement a custom loader instead of using the loader feature in the VirtualScroller." }, { @@ -20122,7 +24523,7 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", + "default": "false", "description": "Whether to load items." }, { @@ -20130,22 +24531,15 @@ "optional": true, "readonly": false, "type": "number", - "default": "", - "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.\nDefault value is half the number of items shown in the view." - }, - { - "name": "onLazyLoad", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" + "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": "VirtualScrollerOrientationType", - "default": "", + "type": "\"both\" | \"horizontal\" | \"vertical\"", + "default": "vertical", "description": "The orientation of scrollbar." }, { @@ -20185,8 +24579,8 @@ "optional": true, "readonly": false, "type": "boolean", - "default": "", - "description": "Used to implement a custom spacer instead of using the spacer feature in the VirtualScroller.\nDefault value is true." + "default": "true", + "description": "Used to implement a custom spacer instead of using the spacer feature in the VirtualScroller." }, { "name": "step", @@ -20209,13 +24603,28 @@ "optional": true, "readonly": false, "type": "string | number", - "default": "", - "description": "Index of the element in tabbing order.\nDefault value is 0." + "default": "0.", + "description": "Index of the element in tabbing order." } ], - "methods": [] + "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." + } + ] }, "VirtualScrollerRangeMethod": { + "description": "Virtual scroller rendered range.", "relatedProp": "", "props": [ { @@ -20246,7 +24655,8 @@ "methods": [] }, "VirtualScrollerScrollIndexChangeEvent": { - "relatedProp": "", + "description": "Custom scroll index change event.", + "relatedProp": "scroll-index-change", "props": [ { "name": "first", @@ -20269,35 +24679,54 @@ "extendedBy": "VirtualScrollerLazyEvent,VirtualScrollerViewport" }, "VirtualScrollerSlots": { + "description": "Defines valid slots in VirtualScroller component.", "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "content slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "item", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "item slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom item template." }, { "name": "loader", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [ + { + "name": "scope", + "optional": false, + "type": "Object", + "description": "header slot's params." + } + ], + "returnType": "VNode[]", + "description": "Custom loader template." } - ], - "methods": [] + ] }, "VirtualScrollerViewport": { - "description": "", - "relatedProp": "", + "description": "Custom virtualscroller viewport metadata.", + "relatedProp": "scroll-index-change", "props": [ { "name": "first", @@ -20320,14 +24749,6 @@ "extendedTypes": "VirtualScrollerScrollIndexChangeEvent" } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "VirtualScrollerEmits": { - "values": "{\n \"lazy-load\": \"Function, \",\n \"scroll\": \"Function, \",\n \"scroll-index-change\": \"Function, \",\n \"update:numToleratedItems\": \"Function, \"\n}" - } - } } } } \ No newline at end of file