UNPKG

primevue

Version:

PrimeVue is a premium UI library for Vue featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock, wh

1,479 lines 157 kB
{ "accordion/multiple": { "description": "When enabled, multiple tabs can be activated at the same time.", "type": "boolean" }, "accordion/activeIndex": { "description": "Index of the active tab or an array of indexes in multiple mode.", "type": "number|array" }, "accordion/lazy": { "description": "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css.", "type": "boolean" }, "accordion/expandIcon": { "description": "Icon of a collapsed tab.", "type": "string" }, "accordion/collapseIcon": { "description": "Icon of a expanded tab.", "type": "string" }, "accordion/tabindex": { "description": "Index of the element in tabbing order.", "type": "number" }, "accordion/selectOnFocus": { "description": "When enabled, the focused tab is activated.", "type": "boolean" }, "accordion/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "accordion/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "autocomplete/modelValue": { "description": "Value of the component.", "type": "any" }, "autocomplete/suggestions": { "description": "An array of suggestions to display.", "type": "array" }, "autocomplete/field": { "description": "Property name or getter function of a suggested object to resolve and display.", "type": "any" }, "autocomplete/optionLabel": { "description": "Property name or getter function to use as the label of an option.", "type": "string | function" }, "autocomplete/optionDisabled": { "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined.", "type": "boolean" }, "autocomplete/optionGroupLabel": { "description": "Property name or getter function to use as the label of an option group.", "type": "string" }, "autocomplete/optionGroupChildren": { "description": "Property name or getter function that refers to the children options of option group.", "type": "string" }, "autocomplete/scrollHeight": { "description": "Maximum height of the suggestions panel.", "type": "string" }, "autocomplete/dropdown": { "description": "Displays a button next to the input field when enabled.", "type": "boolean" }, "autocomplete/dropdownMode": { "description": "Specifies the behavior dropdown button. Default \"blank\" mode sends an empty string and \"current\" mode sends the input value.", "type": "string" }, "autocomplete/autoHighlight": { "description": "Highlights automatically the first item of the dropdown to be selected.", "type": "boolean" }, "autocomplete/multiple": { "description": "Specifies if multiple values can be selected.", "type": "boolean" }, "autocomplete/placeholder": { "description": "Default text to display when no option is selected.", "type": "string" }, "autocomplete/loading": { "description": "Whether the multiselect is in loading state.", "type": "boolean" }, "autocomplete/disabled": { "description": "When present, it specifies that the component should be disabled.", "type": "boolean" }, "autocomplete/invalid": { "description": "When present, it specifies that the component should have invalid state style.", "type": "boolean" }, "autocomplete/variant": { "description": "Specifies the input variant of the component.", "type": "string" }, "autocomplete/dataKey": { "description": "A property to uniquely identify an option.", "type": "string" }, "autocomplete/minLength": { "description": "Minimum number of characters to initiate a search.", "type": "number" }, "autocomplete/delay": { "description": "Delay between keystrokes to wait before sending a query.", "type": "number" }, "autocomplete/appendTo": { "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" }, "autocomplete/forceSelection": { "description": "When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions.", "type": "boolean" }, "autocomplete/completeOnFocus": { "description": "Whether to run a query when input receives focus.", "type": "boolean" }, "autocomplete/inputId": { "description": "Identifier of the underlying input element.", "type": "string" }, "autocomplete/inputStyle": { "description": "Inline style of the input field.", "type": "object" }, "autocomplete/inputClass": { "description": "Style class of the input field.", "type": "string | object" }, "autocomplete/inputProps": { "description": "Used to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.", "type": "object" }, "autocomplete/panelStyle": { "description": "Inline style of the overlay panel.", "type": "object" }, "autocomplete/panelClass": { "description": "Style class of the overlay panel.", "type": "string | object" }, "autocomplete/panelProps": { "description": "Used to pass all properties of the HTMLDivElement to the overlay panel inside the component.", "type": "object" }, "autocomplete/dropdownIcon": { "description": "Icon to display in the dropdown.", "type": "string" }, "autocomplete/dropdownClass": { "description": "Style class of the dropdown button.", "type": "string" }, "autocomplete/loadingIcon": { "description": "Icon to display in loading state.", "type": "string" }, "autocomplete/removeTokenIcon": { "description": "Icon to display in chip remove action.", "type": "string" }, "autocomplete/virtualScrollerOptions": { "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.", "type": "object" }, "autocomplete/autoOptionFocus": { "description": "Whether to focus on the first visible or selected element when the overlay panel is shown.", "type": "boolean" }, "autocomplete/selectOnFocus": { "description": "When enabled, the focused option is selected.", "type": "boolean" }, "autocomplete/searchLocale": { "description": "Locale to use in searching. The default locale is the host environment's current locale.", "type": "string" }, "autocomplete/searchMessage": { "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "autocomplete/selectionMessage": { "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "autocomplete/emptySelectionMessage": { "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "autocomplete/emptySearchMessage": { "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "autocomplete/tabindex": { "description": "Index of the element in tabbing order.", "type": "number" }, "autocomplete/aria-label": { "description": "Defines a string value that labels an interactive element.", "type": "string" }, "autocomplete/aria-labelledby": { "description": "Identifier of the underlying input element.", "type": "string" }, "autocomplete/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "autocomplete/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "avatar/label": { "description": "Defines the text to display.", "type": "string" }, "avatar/icon": { "description": "Defines the icon to display.", "type": "string" }, "avatar/image": { "description": "Defines the image to display.", "type": "string" }, "avatar/size": { "description": "Size of the element, valid options are \"large\" and \"xlarge\".", "type": "string" }, "avatar/shape": { "description": "Shape of the element, valid options are \"square\" and \"circle\".", "type": "string" }, "avatar/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "avatar/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "avatargroup/label": { "description": "Defines the text to display.", "type": "string" }, "avatargroup/icon": { "description": "Defines the icon to display.", "type": "string" }, "avatargroup/image": { "description": "Defines the image to display.", "type": "string" }, "avatargroup/size": { "description": "Size of the element, valid options are \"large\" and \"xlarge\".", "type": "string" }, "avatargroup/shape": { "description": "Shape of the element, valid options are \"square\" and \"circle\".", "type": "string" }, "avatargroup/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "avatargroup/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "badge/value": { "description": "Value to display inside the badge.", "type": "string | number" }, "badge/severity": { "description": "Severity type of the badge. Valid severities are \"secondary\", \"success\", \"info\", \"warn\", \"danger\" and \"contrast\".", "type": "string" }, "badge/size": { "description": "Size of the badge, valid options are \"large\" and \"xlarge\".", "type": "string" }, "badge/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "badge/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "blockui/blocked": { "description": "Controls the blocked state.", "type": "array" }, "blockui/fullscreen": { "description": "When enabled, the whole document gets blocked.", "type": "menuitem" }, "blockui/baseZIndex": { "description": "Base zIndex value to use in layering.", "type": "number" }, "blockui/autoZIndex": { "description": "Whether to automatically manage layering.", "type": "boolean" }, "blockui/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "blockui/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "breadcrumb/model": { "description": "An array of menuitems.", "type": "array" }, "breadcrumb/home": { "description": "Configuration for the home icon.", "type": "menuitem" }, "breadcrumb/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "breadcrumb/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "button/label": { "description": "Text of the button.", "type": "string" }, "button/icon": { "description": "Name of the icon.", "type": "string" }, "button/iconPos": { "description": "Position of the icon, valid values are \"left\", \"right\", \"bottom\" and \"top\".", "type": "string" }, "button/iconClass": { "description": "Style class of the icon.", "type": "string" }, "button/badge": { "description": "Value of the badge.", "type": "string" }, "button/badgeClass": { "description": "Style class of the badge.", "type": "string" }, "button/loading": { "description": "Whether the button is in loading state.", "type": "boolean" }, "button/loadingIcon": { "description": "Icon to display in loading state.", "type": "string" }, "button/link": { "description": "Add a link style to the button.", "type": "boolean" }, "button/severity": { "description": "Defines the style of the button, valid values are \"secondary\", \"success\", \"info\", \"warn\", \"help\", \"danger\", \"contrast\".", "type": "string" }, "button/raised": { "description": "Add a shadow to indicate elevation.", "type": "boolean" }, "button/rounded": { "description": "Add a circular border radius to the button.", "type": "boolean" }, "button/text": { "description": "Add a textual class to the button without a background initially.", "type": "boolean" }, "button/outlined": { "description": "Add a border class without a background initially.", "type": "boolean" }, "button/size": { "description": "Defines the size of the button, valid values are \"small\" and \"large\".", "type": "string" }, "button/plain": { "description": "Add a plain textual class to the button without a background initially.", "type": "boolean" }, "button/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "button/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "card/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "card/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "carousel/value": { "description": "An array of objects to display.", "type": "array" }, "carousel/page": { "description": "Index of the first item.", "type": "number" }, "carousel/circular": { "description": "Defines if scrolling would be infinite.", "type": "boolean" }, "carousel/autoplayInterval": { "description": "Time in milliseconds to scroll items automatically.", "type": "number" }, "carousel/numVisible": { "description": "Number of items per page.", "type": "number" }, "carousel/numScroll": { "description": "Number of items to scroll.", "type": "number" }, "carousel/responsiveOptions": { "description": "An array of options for responsive design.", "type": "any" }, "carousel/orientation": { "description": "Specifies the layout of the component, valid values are \"horizontal\" and \"vertical\".", "type": "string" }, "carousel/verticalViewPortHeight": { "description": "Height of the viewport in vertical layout.", "type": "string" }, "carousel/contentClass": { "description": "Style class of main content.", "type": "string" }, "carousel/containerClass": { "description": "Style class of the viewport container.", "type": "string" }, "carousel/indicatorsContentClass": { "description": "Style class of the indicator items.", "type": "string" }, "carousel/showNavigators": { "description": "Whether to display navigation buttons in container.", "type": "boolean" }, "carousel/showIndicators": { "description": "Whether to display indicator container.", "type": "boolean" }, "carousel/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "carousel/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "cascadeselect/modelValue": { "description": "Value of the component.", "type": "any" }, "cascadeselect/options": { "description": "An array of selectitems to display as the available options.", "type": "array" }, "cascadeselect/optionLabel": { "description": "Property name or getter function to use as the label of an option.", "type": "string | function" }, "cascadeselect/optionValue": { "description": "Property name or getter function to use as the value of an option, defaults to the option itself when not defined.", "type": "string | function" }, "cascadeselect/optionDisabled": { "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined.", "type": "boolean" }, "cascadeselect/optionGroupLabel": { "description": "Property name or getter function to use as the label of an option group.", "type": "string | function" }, "cascadeselect/optionGroupChildren": { "description": "Property name or getter function to retrieve the items of a group.", "type": "array | function" }, "cascadeselect/placeholder": { "description": "Default text to display when no option is selected.", "type": "string" }, "cascadeselect/disabled": { "description": "When present, it specifies that the component should be disabled.", "type": "boolean" }, "cascadeselect/invalid": { "description": "When present, it specifies that the component should have invalid state style.", "type": "boolean" }, "cascadeselect/variant": { "description": "Specifies the input variant of the component.", "type": "string" }, "cascadeselect/dataKey": { "description": "A property to uniquely identify an option.", "type": "string" }, "cascadeselect/inputStyle": { "description": "Inline style of the input field.", "type": "object" }, "cascadeselect/inputClass": { "description": "Style class of the input field.", "type": "string | object" }, "cascadeselect/inputProps": { "description": "Used to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.", "type": "object" }, "cascadeselect/panelStyle": { "description": "Inline style of the overlay panel.", "type": "object" }, "cascadeselect/panelClass": { "description": "Style class of the overlay panel.", "type": "string | object" }, "cascadeselect/panelProps": { "description": "Used to pass all properties of the HTMLDivElement to the overlay panel inside the component.", "type": "object" }, "cascadeselect/appendTo": { "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" }, "cascadeselect/loading": { "description": "Whether the multiselect is in loading state.", "type": "boolean" }, "cascadeselect/dropdownIcon": { "description": "Icon to display in the dropdown.", "type": "string" }, "cascadeselect/loadingIcon": { "description": "Icon to display in loading state.", "type": "string" }, "cascadeselect/optionGroupIcon": { "description": "Icon to display in the option group.", "type": "string" }, "cascadeselect/autoOptionFocus": { "description": "Whether to focus on the first visible or selected element when the overlay panel is shown.", "type": "boolean" }, "cascadeselect/selectOnFocus": { "description": "When enabled, the focused option is selected/opened.", "type": "boolean" }, "cascadeselect/searchLocale": { "description": "Locale to use in searching. The default locale is the host environment's current locale.", "type": "string" }, "cascadeselect/searchMessage": { "description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "cascadeselect/selectionMessage": { "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "cascadeselect/emptySelectionMessage": { "description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "cascadeselect/emptySearchMessage": { "description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.", "type": "string" }, "cascadeselect/tabindex": { "description": "Index of the element in tabbing order.", "type": "number" }, "cascadeselect/aria-label": { "description": "Defines a string value that labels an interactive element.", "type": "string" }, "cascadeselect/aria-labelledby": { "description": "Identifier of the underlying input element.", "type": "string" }, "cascadeselect/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "cascadeselect/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "chart/type": { "description": "Type of the chart.", "type": "string" }, "chart/data": { "description": "Data to display.", "type": "any" }, "chart/options": { "description": "Options to customize the chart.", "type": "any" }, "chart/plugins": { "description": "Used to custom plugins of the chart.", "type": "any" }, "chart/width": { "description": "Width of the chart in non-responsive mode.", "type": "number" }, "chart/height": { "description": "Height of the chart in non-responsive mode.", "type": "number" }, "chart/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "chart/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "checkbox/value": { "description": "Value of the checkbox.", "type": "any" }, "checkbox/modelValue": { "description": "Value binding of the checkbox.", "type": "any" }, "checkbox/binary": { "description": "Allows to select a boolean value instead of multiple values.", "type": "boolean" }, "checkbox/disabled": { "description": "When present, it specifies that the element should be disabled.", "type": "boolean" }, "checkbox/invalid": { "description": "When present, it specifies that the component should have invalid state style.", "type": "boolean" }, "checkbox/variant": { "description": "Specifies the input variant of the component.", "type": "string" }, "checkbox/readonly": { "description": "When present, it specifies that an input field is read-only.", "type": "boolean" }, "checkbox/required": { "description": "When present, it specifies that the element is required.", "type": "boolean" }, "checkbox/tabindex": { "description": "Index of the element in tabbing order.", "type": "number" }, "checkbox/trueValue": { "description": "Value in checked state.", "type": "any" }, "checkbox/falseValue": { "description": "Value in unchecked state.", "type": "any" }, "checkbox/inputId": { "description": "Identifier of the underlying input element.", "type": "string" }, "checkbox/inputClass": { "description": "Style class of the input field.", "type": "string | object" }, "checkbox/inputStyle": { "description": "Inline style of the input field.", "type": "object" }, "checkbox/inputProps": { "description": "Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.", "type": "object" }, "checkbox/aria-labelledby": { "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs.", "type": "string" }, "checkbox/aria-label": { "description": "Used to define a string that labels the element.", "type": "string" }, "checkbox/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "checkbox/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "chip/label": { "description": "Defines the text to display.", "type": "string" }, "chip/icon": { "description": "Defines the icon to display.", "type": "string" }, "chip/image": { "description": "Defines the image to display.", "type": "string" }, "chip/removable": { "description": "Whether to display a remove icon.", "type": "boolean" }, "chip/removeIconClass": { "description": "Icon of the remove element.", "type": "string" }, "chip/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "chip/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "colorpicker/modelValue": { "description": "Value of the component.", "type": "string" }, "colorpicker/defaultColor": { "description": "Initial color to display when value is not defined.", "type": "string" }, "colorpicker/inline": { "description": "Whether to display as an overlay or not.", "type": "boolean" }, "colorpicker/format": { "description": "Format to use in value binding, supported formats are \"hex\", \"rgb\" and \"hsb\".", "type": "string" }, "colorpicker/disabled": { "description": "When present, it specifies that the component should be disabled.", "type": "boolean" }, "colorpicker/tabindex": { "description": "Index of the element in tabbing order.", "type": "string" }, "colorpicker/baseZIndex": { "description": "Base zIndex value to use in layering.", "type": "number" }, "colorpicker/autoZIndex": { "description": "Whether to automatically manage layering.", "type": "boolean" }, "colorpicker/panelClass": { "description": "Style class of the overlay panel.", "type": "string" }, "colorpicker/appendTo": { "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" }, "colorpicker/aria-labelledby": { "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs.", "type": "string" }, "colorpicker/aria-label": { "description": "Used to define a string that labels the element.", "type": "string" }, "colorpicker/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "colorpicker/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "column/columnKey": { "description": "Identifier of a column if field property is not defined.", "type": "any" }, "column/field": { "description": "Property represented by the column.", "type": "string" }, "column/sortField": { "description": "Property name to use in sorting, defaults to field.", "type": "string" }, "column/filterField": { "description": "Property name to use in filtering, defaults to field.", "type": "string" }, "column/sortable": { "description": "Defines if a column is sortable.", "type": "any" }, "column/header": { "description": "Header content of the column.", "type": "any" }, "column/footer": { "description": "Footer content of the column.", "type": "any" }, "column/style": { "description": "Inline style of header, body and footer cells.", "type": "object" }, "column/class": { "description": "Style class of header, body and footer cells.", "type": "string" }, "column/headerStyle": { "description": "Inline style of the column header.", "type": "object" }, "column/headerClass": { "description": "Style class of the column header.", "type": "string" }, "column/bodyStyle": { "description": "Inline style of the column body.", "type": "object" }, "column/bodyClass": { "description": "Style class of the column body.", "type": "string" }, "column/footerStyle": { "description": "Inline style of the column footer.", "type": "object" }, "column/footerClass": { "description": "Style class of the footer body.", "type": "string" }, "column/showFilterMenu": { "description": "Whether to display the filter overlay.", "type": "boolean" }, "column/showFilterOperator": { "description": "When enabled, match all and match any operator selector is displayed.", "type": "boolean" }, "column/showClearButton": { "description": "Displays a button to clear the column filtering.", "type": "boolean" }, "column/showApplyButton": { "description": "Displays a button to apply the column filtering.", "type": "boolean" }, "column/showFilterMatchModes": { "description": "Whether to show the match modes selector.", "type": "boolean" }, "column/showAddButton": { "description": "When enabled, a button is displayed to add more rules.", "type": "boolean" }, "column/filterMatchModeOptions": { "description": "An array of label-value pairs to override the global match mode options.", "type": "array" }, "column/maxConstraints": { "description": "Maximum number of constraints for a column filter.", "type": "number" }, "column/excludeGlobalFilter": { "description": "Whether to exclude from global filtering or not.", "type": "boolean" }, "column/filterHeaderStyle": { "description": "Inline style of the column filter header in row filter display.", "type": "object" }, "column/filterHeaderClass": { "description": "Style class of the column filter header in row filter display.", "type": "string" }, "column/filterMenuStyle": { "description": "Inline style of the column filter overlay.", "type": "object" }, "column/filterMenuClass": { "description": "Style class of the column filter overlay.", "type": "string" }, "column/selectionMode": { "description": "Defines column based selection mode, options are \"single\" and \"multiple\".", "type": "string" }, "column/expander": { "description": "Displays an icon to toggle row expansion.", "type": "boolean" }, "column/colspan": { "description": "Number of columns to span for grouping.", "type": "number" }, "column/rowspan": { "description": "Number of rows to span for grouping.", "type": "number" }, "column/rowReorder": { "description": "Whether this column displays an icon to reorder the rows.", "type": "boolean" }, "column/rowReorderIcon": { "description": "Icon of the drag handle to reorder rows.", "type": "string" }, "column/reorderableColumn": { "description": "Defines if the column itself can be reordered with dragging.", "type": "boolean" }, "column/rowEditor": { "description": "When enabled, column displays row editor controls.", "type": "boolean" }, "column/frozen": { "description": "Whether the column is fixed in horizontal scrolling.", "type": "boolean" }, "column/alignFrozen": { "description": "Position of a frozen column, valid values are left and right.", "type": "string" }, "column/exportable": { "description": "Whether the column is included in data export.", "type": "boolean" }, "column/exportHeader": { "description": "Custom export header of the column to be exported as CSV.", "type": "string" }, "column/exportFooter": { "description": "Custom export footer of the column to be exported as CSV.", "type": "string" }, "column/hidden": { "description": "Whether the column is rendered.", "type": "boolean" }, "column/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "columngroup/type": { "description": "Defines the type of the group.", "type": "string" }, "columngroup/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "commandmenu/options": { "description": "An array of options to display. Can be flat or grouped when optionGroupLabel and optionGroupChildren are provided.", "type": "array" }, "commandmenu/optionLabel": { "description": "Property name or getter function to use as the label of an option.", "type": "string | function" }, "commandmenu/optionValue": { "description": "Property name or getter function to use as the value of an option.", "type": "string | function" }, "commandmenu/optionDisabled": { "description": "Property name or getter function to use as the disabled flag of an option.", "type": "string | function" }, "commandmenu/optionGroupLabel": { "description": "Property name or getter function to use as the label of an option group.", "type": "string | function" }, "commandmenu/optionGroupChildren": { "description": "Property name or getter function of a group's children options.", "type": "string | function" }, "commandmenu/optionKeywords": { "description": "Property name or getter function that resolves extra keywords fed to the scorer alongside the label.", "type": "string | function" }, "commandmenu/search": { "description": "Current search string. Use with v-model:search for two-way binding.", "type": "string" }, "commandmenu/modelValue": { "description": "Current selected value. Use with v-model for two-way binding.", "type": "any" }, "commandmenu/filter": { "description": "Custom scoring function that replaces the default substring scorer. Returns a positive number if the option matches.", "type": "function" }, "commandmenu/placeholder": { "description": "Placeholder text for the search input.", "type": "string" }, "commandmenu/scrollHeight": { "description": "Max height of the underlying Listbox list.", "type": "string" }, "commandmenu/emptyMessage": { "description": "Text shown when options is empty. Defaults to the locale emptyMessage.", "type": "string" }, "commandmenu/emptyFilterMessage": { "description": "Text shown when no options match the current search. Defaults to the locale emptySearchMessage.", "type": "string" }, "commandmenu/autoFocus": { "description": "Autofocus the search input on mount.", "type": "boolean" }, "commandmenu/as": { "description": "Use to change the HTML tag of root element.", "type": "string | component" }, "commandmenu/asChild": { "description": "When enabled, it changes the default rendered element for the one passed as a child element.", "type": "boolean" }, "commandmenu/dt": { "description": "It generates scoped CSS variables using design tokens for the component.", "type": "object" }, "commandmenu/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "commandmenu/ptOptions": { "description": "Used to configure passthrough(pt) options of the component.", "type": "object" }, "commandmenu/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "compare/modelValue": { "description": "Value of the component. Pair with v-model for two-way binding.", "type": "number" }, "compare/min": { "description": "Minimum boundary value.", "type": "number" }, "compare/max": { "description": "Maximum boundary value.", "type": "number" }, "compare/step": { "description": "Step factor to increment/decrement the value.", "type": "number" }, "compare/orientation": { "description": "Orientation of the compare slider.", "type": "horizontal | vertical" }, "compare/slideOnHover": { "description": "Whether the slider moves on hover.", "type": "boolean" }, "compare/disabled": { "description": "Whether the component is disabled.", "type": "boolean" }, "compare/readonly": { "description": "Whether the component is read-only.", "type": "boolean" }, "compare/invalid": { "description": "When present, it specifies that the component should be invalid.", "type": "boolean" }, "compare/tabindex": { "description": "The tab index of the hidden range input.", "type": "number" }, "compare/ariaLabel": { "description": "Establishes a string value that labels the component.", "type": "string" }, "compare/ariaLabelledby": { "description": "Establishes relationships between the component and label(s).", "type": "string" }, "compare/name": { "description": "Name of the hidden input.", "type": "string" }, "compare/as": { "description": "Use to change the HTML tag of root element.", "type": "string | component" }, "compare/asChild": { "description": "When enabled, it changes the default rendered element for the one passed as a child element.", "type": "boolean" }, "compare/dt": { "description": "It generates scoped CSS variables using design tokens for the component.", "type": "object" }, "compare/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "compare/ptOptions": { "description": "Used to configure passthrough(pt) options of the component.", "type": "object" }, "compare/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "confirmdialog/group": { "description": "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.", "type": "string" }, "confirmdialog/breakpoints": { "description": "Object literal to define widths per screen size.", "type": "object" }, "confirmdialog/draggable": { "description": "Whether the dialog can be relocated by dragging.", "type": "boolean" }, "confirmdialog/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "confirmdialog/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "confirmpopup/group": { "description": "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.", "type": "string" }, "confirmpopup/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "confirmpopup/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "contextmenu/model": { "description": "An array of menuitems.", "type": "array" }, "contextmenu/appendTo": { "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached.", "type": "string" }, "contextmenu/baseZIndex": { "description": "Base zIndex value to use in layering.", "type": "number" }, "contextmenu/autoZIndex": { "description": "Whether to automatically manage layering.", "type": "boolean" }, "contextmenu/global": { "description": "Attaches the menu to document instead of a particular item.", "type": "boolean" }, "contextmenu/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "contextmenu/unstyled": { "description": "When enabled, it removes component related styles in the core.", "type": "boolean" }, "datatable/value": { "description": "An array of objects to display.", "type": "array" }, "datatable/dataKey": { "description": "Name of the field that uniquely identifies the a record in the data.", "type": "string|function" }, "datatable/rows": { "description": "Number of rows to display per page.", "type": "number" }, "datatable/first": { "description": "Index of the first row to be displayed.", "type": "number" }, "datatable/totalRecords": { "description": "Number of total records, defaults to length of value when not defined.", "type": "number" }, "datatable/paginator": { "description": "When specified as true, enables the pagination.", "type": "boolean" }, "datatable/paginatorPosition": { "description": "Position of the paginator, options are \"top\",\"bottom\" or \"both\".", "type": "string" }, "datatable/alwaysShowPaginator": { "description": "Whether to show it even there is only one page.", "type": "boolean" }, "datatable/paginatorTemplate": { "description": "emplate of the paginator.", "type": "string" }, "datatable/pageLinkSize": { "description": "Number of page links to display.", "type": "number" }, "datatable/rowsPerPageOptions": { "description": "Array of integer values to display inside rows per page dropdown.", "type": "array" }, "datatable/currentPageReportTemplate": { "description": "Template of the current page report element.", "type": "string" }, "datatable/lazy": { "description": "Defines if data is loaded and interacted with in lazy manner.", "type": "boolean" }, "datatable/loading": { "description": "Displays a loader to indicate data load is in progress.", "type": "boolean" }, "datatable/loadingIcon": { "description": "The icon to show while indicating data load is in progress.", "type": "string" }, "datatable/sortField": { "description": "Property name or a getter function of a row data used for sorting by default", "type": "string" }, "datatable/sortOrder": { "description": "Order to sort the data by default.", "type": "number" }, "datatable/defaultSortOrder": { "description": "Default sort order of an unsorted column.", "type": "number" }, "datatable/multiSortMeta": { "description": "An array of SortMeta objects to sort the data by default in multiple sort mode.", "type": "array" }, "datatable/sortMode": { "description": "Defines whether sorting works on single column or on multiple columns.", "type": "string" }, "datatable/removableSort": { "description": "When enabled, columns can have an un-sorted state.", "type": "boolean" }, "datatable/filters": { "description": "Filters object with key-value pairs to define the filters.", "type": "object" }, "datatable/filterDisplay": { "description": "Layout of the filter elements, valid values are \"row\" and \"menu\".", "type": "string" }, "datatable/filterLocale": { "description": "Locale to use in filtering. The default locale is the host environment's current locale.", "type": "string" }, "datatable/selection": { "description": "Selected row in single mode or an array of values in multiple mode.", "type": "any" }, "datatable/selectionMode": { "description": "Specifies the selection mode, valid values are \"single\" and \"multiple\".", "type": "string" }, "datatable/compareSelectionBy": { "description": "Algorithm to define if a row is selected, valid values are \"equals\" that compares by reference and \"deepEquals\" that compares all fields.", "type": "string" }, "datatable/metaKeySelection": { "description": "Defines whether metaKey is requred or not for the selection. When true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.", "type": "boolean" }, "datatable/contextMenu": { "description": "Enables context menu integration.", "type": "boolean" }, "datatable/contextMenuSelection": { "description": "Selected row instance with the ContextMenu.", "type": "object" }, "datatable/rowHover": { "description": "When enabled, background of the rows change on hover.", "type": "boolean" }, "datatable/selectAll": { "description": "Whether all data is selected.", "type": "boolean" }, "datatable/csvSeparator": { "description": "Character to use as the csv separator.", "type": "string" }, "datatable/exportFilename": { "description": "Name of the exported file.", "type": "string" }, "datatable/exportFunction": { "description": "Custom function to export data.", "type": "function" }, "datatable/autoLayout": { "description": "Whether the cell widths scale according to their content or not. Does not apply to scrollable tables.", "type": "boolean" }, "datatable/resizableColumns": { "description": "When enabled, columns can be resized using drag and drop.", "type": "boolean" }, "datatable/columnResizeMode": { "description": "Defines whether the overall table width should change on column resize, valid values are \"fit\" and \"expand\".", "type": "string" }, "datatable/reorderableColumns": { "description": "When enabled, columns can be reordered using drag and drop.", "type": "boolean" }, "datatable/expandedRows": { "description": "A collection of row data display as expanded.", "type": "array" }, "datatable/expandedRowIcon": { "description": "Icon of the row toggler to display the row as expanded.", "type": "string" }, "datatable/collapsedRowIcon": { "description": "Icon of the row toggler to display the row as collapsed.", "type": "string" }, "datatable/rowGroupMode": { "description": "Defines the row group mode, valid options are \"subheader\" and \"rowspan\".", "type": "string" }, "datatable/groupRowsBy": { "description": "One or more field names to use in row grouping.", "type": "string|array" }, "datatable/expandableRowGroups": { "description": "Whether the row groups can be expandable.", "type": "boolean" }, "datatable/expandedRowGroups": { "description": "An array of group field values whose groups would be rendered as expanded.", "type": "array" }, "datatable/stateStorage": { "description": "Defines where a stateful table keeps its state, valid values are \"session\" for sessionStorage and \"local\" for localStorage.", "type": "string" }, "datatable/stateKey": { "description": "Unique identifier of a stateful table to use in state storage.", "type": "string" }, "datatable/editMode": { "description": "Defines the incell editing mode, valid options are \"cell\" and \"row\".", "type": "string" }, "datatable/editingRows": { "description": "A collection of rows to represent the current editing data in row edit mode.", "type": "array" }, "datatable/rowClass": { "description": "A function that takes the row data and returns a string to apply a particular class for the row.", "type": "function" }, "datatable/rowStyle": { "description": "A function that takes the row data as a parameter and returns the inline style for the corresponding row.", "type": "object" }, "datatable/scrollable": { "description": "When specified, enables horizontal and/or vertical scrolling.", "type": "boolean" }, "datatable/scrollDirection": { "description": "Orientation of the scrolling, options are \"vertical\", \"horizontal\" and \"both\".", "type": "string" }, "datatable/scrollHeight": { "description": "Height of the scroll viewport in fixed units or the \"flex\" keyword for a dynamic size.", "type": "string" }, "datatable/virtualScrollerOptions": { "description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it. Note: Currently only vertical orientation mode is supported.", "type": "object" }, "datatable/frozenValue": { "description": "Items of the frozen part in scrollable DataTable.", "type": "array" }, "datatable/breakpoint": { "description": "The breakpoint to define the maximum width boundary when using stack responsive layout.", "type": "string" }, "datatable/showGridlines": { "description": "Whether to show grid lines between cells.", "type": "boolean" }, "datatable/stripedRows": { "description": "Whether to displays rows with alternating colors.", "type": "boolean" }, "datatable/highlightOnSelect": { "description": "Highlights automatically the first item.", "type": "boolean" }, "datatable/size": { "description": "Defines the size of the table.", "type": "string" }, "datatable/tableStyle": { "description": "Inline style of the table element.", "type": "object" }, "datatable/tableClass": { "description": "Style class of the table element.", "type": "string" }, "datatable/pt": { "description": "Used to pass attributes to DOM elements inside the component.", "type": "any" }, "datatable/unstyled": { "description": "When enabled, it removes component related styles in the co