primevue
Version:
[](https://opensource.org/licenses/MIT) [](https://badge.fury.io/js/primevue) [![Discord Chat](https://img.shields.io/discord/55794023
1,383 lines • 548 kB
JSON
{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"framework": "vue",
"name": "PrimeVue",
"version": "3.26.1",
"contributions": {
"html": {
"types-syntax": "typescript",
"description-markup": "markdown",
"tags": [
{
"name": "Accordion",
"source": {
"module": "PrimeVue",
"symbol": "Accordion"
},
"doc-url": "https://primevue.org/accordion",
"description": "Accordion groups a collection of contents in tabs.",
"attributes": [
{
"name": "multiple",
"default": "false",
"doc-url": "https://primevue.org/accordion",
"description": "When enabled, multiple tabs can be activated at the same time.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "activeIndex",
"default": "null",
"doc-url": "https://primevue.org/accordion",
"description": "Index of the active tab or an array of indexes in multiple mode.",
"value": {
"kind": "expression",
"type": "number|array"
}
},
{
"name": "lazy",
"default": "false",
"doc-url": "https://primevue.org/accordion",
"description": "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "expandIcon",
"default": "pi-chevron-right",
"doc-url": "https://primevue.org/accordion",
"description": "Icon of a collapsed tab.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "collapseIcon",
"default": "pi-chevron-down",
"doc-url": "https://primevue.org/accordion",
"description": "Icon of a expanded tab.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "tabindex",
"default": "0",
"doc-url": "https://primevue.org/accordion",
"description": "Index of the element in tabbing order.",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "selectOnFocus",
"default": "false",
"doc-url": "https://primevue.org/accordion",
"description": "When enabled, the focused tab is activated.",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"events": [
{
"name": "tab-open",
"doc-url": "https://primevue.org/accordion",
"description": "Callback to invoke when a tab gets expanded.",
"arguments": [
{
"name": "originalEvent",
"doc-url": "https://primevue.org/accordion",
"type": "object",
"description": "Original event"
},
{
"name": "index",
"doc-url": "https://primevue.org/accordion",
"type": "number",
"description": "Opened tab index"
}
]
},
{
"name": "tab-close",
"doc-url": "https://primevue.org/accordion",
"description": "Callback to invoke when an active tab is collapsed by clicking on the header.",
"arguments": [
{
"name": "originalEvent",
"doc-url": "https://primevue.org/accordion",
"type": "object",
"description": "Original event"
},
{
"name": "index",
"doc-url": "https://primevue.org/accordion",
"type": "number",
"description": "Closed tab index"
}
]
},
{
"name": "tab-click",
"doc-url": "https://primevue.org/accordion",
"description": "Callback to invoke when an active tab is clicked.",
"arguments": [
{
"name": "originalEvent",
"doc-url": "https://primevue.org/accordion",
"type": "object",
"description": "Original event"
},
{
"name": "index",
"doc-url": "https://primevue.org/accordion",
"type": "number",
"description": "Index of the clicked tab"
}
]
}
]
},
{
"name": "AccordionTab",
"source": {
"module": "PrimeVue",
"symbol": "AccordionTab"
},
"doc-url": "https://primevue.org/accordiontab",
"description": "Accordion element consists of one or more AccordionTab elements.",
"attributes": [
{
"name": "header",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Orientation of tab headers.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "headerStyle",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Inline style of the tab header.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "headerClass",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Style class of the tab header.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "headerProps",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Uses to pass all properties of the HTMLDivElement to the tab header.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "headerActionProps",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "contentStyle",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Inline style of the tab content.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "contentClass",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Style class of the tab content.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "contentProps",
"default": "null",
"doc-url": "https://primevue.org/accordiontab",
"description": "Uses to pass all properties of the HTMLDivElement to the tab content.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "disabled",
"default": "false",
"doc-url": "https://primevue.org/accordiontab",
"description": "Whether the tab is disabled.",
"value": {
"kind": "expression",
"type": "boolean"
}
}
]
},
{
"name": "AutoComplete",
"source": {
"module": "PrimeVue",
"symbol": "AutoComplete"
},
"doc-url": "https://primevue.org/autocomplete",
"description": "AutoComplete is an input component that provides real-time suggestions when being typed.",
"attributes": [
{
"name": "modelValue",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Value of the component.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "suggestions",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "An array of suggestions to display.",
"value": {
"kind": "expression",
"type": "array"
}
},
{
"name": "field",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Property name or getter function of a suggested object to resolve and display.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "optionLabel",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Property name or getter function to use as the label of an option.",
"value": {
"kind": "expression",
"type": "string | function"
}
},
{
"name": "optionDisabled",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "optionGroupLabel",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Property name or getter function to use as the label of an option group.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "optionGroupChildren",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Property name or getter function that refers to the children options of option group.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "scrollHeight",
"default": "200px",
"doc-url": "https://primevue.org/autocomplete",
"description": "Maximum height of the suggestions panel.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "dropdown",
"default": "false",
"doc-url": "https://primevue.org/autocomplete",
"description": "Displays a button next to the input field when enabled.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "dropdownMode",
"default": "blank",
"doc-url": "https://primevue.org/autocomplete",
"description": "Specifies the behavior dropdown button. Default \"blank\" mode sends an empty string and \"current\" mode sends the input value.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "autoHighlight",
"default": false,
"doc-url": "https://primevue.org/autocomplete",
"description": "Highlights automatically the first item of the dropdown to be selected.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "multiple",
"default": "false",
"doc-url": "https://primevue.org/autocomplete",
"description": "Specifies if multiple values can be selected.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "placeholder",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Default text to display when no option is selected.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "disabled",
"default": "false",
"doc-url": "https://primevue.org/autocomplete",
"description": "When present, it specifies that the component should be disabled.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "dataKey",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "A property to uniquely identify an option.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "minLength",
"default": "1",
"doc-url": "https://primevue.org/autocomplete",
"description": "Minimum number of characters to initiate a search.",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "delay",
"default": "300",
"doc-url": "https://primevue.org/autocomplete",
"description": "Delay between keystrokes to wait before sending a query.",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "appendTo",
"default": "body",
"doc-url": "https://primevue.org/autocomplete",
"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.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "forceSelection",
"default": "false",
"doc-url": "https://primevue.org/autocomplete",
"description": "When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "completeOnFocus",
"default": "false",
"doc-url": "https://primevue.org/autocomplete",
"description": "Whether to run a query when input receives focus.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "inputId",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Identifier of the underlying input element.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "inputStyle",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Inline style of the input field.",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "inputClass",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Style class of the input field.",
"value": {
"kind": "expression",
"type": "string | object"
}
},
{
"name": "inputProps",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "panelStyle",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Inline style of the overlay panel.",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "panelClass",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Style class of the overlay panel.",
"value": {
"kind": "expression",
"type": "string | object"
}
},
{
"name": "panelProps",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "loadingIcon",
"default": "pi pi-spinner",
"doc-url": "https://primevue.org/autocomplete",
"description": "Icon to display in loading state.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "virtualScrollerOptions",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "autoOptionFocus",
"default": "true",
"doc-url": "https://primevue.org/autocomplete",
"description": "Whether to focus on the first visible or selected element when the overlay panel is shown.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "selectOnFocus",
"default": "false",
"doc-url": "https://primevue.org/autocomplete",
"description": "When enabled, the focused option is selected.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "searchLocale",
"default": "undefined",
"doc-url": "https://primevue.org/autocomplete",
"description": "Locale to use in searching. The default locale is the host environment's current locale.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "searchMessage",
"default": "{0} results are available",
"doc-url": "https://primevue.org/autocomplete",
"description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "selectionMessage",
"default": "{0} items selected",
"doc-url": "https://primevue.org/autocomplete",
"description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "emptySelectionMessage",
"default": "No selected item",
"doc-url": "https://primevue.org/autocomplete",
"description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "emptySearchMessage",
"default": "No results found",
"doc-url": "https://primevue.org/autocomplete",
"description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "tabindex",
"default": "0",
"doc-url": "https://primevue.org/autocomplete",
"description": "Index of the element in tabbing order.",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "aria-label",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Defines a string value that labels an interactive element.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "aria-labelledby",
"default": "null",
"doc-url": "https://primevue.org/autocomplete",
"description": "Identifier of the underlying input element.",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"events": [
{
"name": "change",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke on value change.",
"arguments": [
{
"name": "event.originalEvent",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Browser event"
},
{
"name": "event.value",
"doc-url": "https://primevue.org/autocomplete",
"type": "string",
"description": "Selected option value"
}
]
},
{
"name": "focus",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke when component receives focus.",
"arguments": [
{
"name": "event",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Browser event"
}
]
},
{
"name": "blur",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke when component loses focus.",
"arguments": [
{
"name": "event",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Browser event"
}
]
},
{
"name": "item-select",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke when a suggestion is selected.",
"arguments": [
{
"name": "originalEvent",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Original event"
},
{
"name": "value",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Selected item"
}
]
},
{
"name": "item-unselect",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke when a selected value is removed.",
"arguments": [
{
"name": "originalEvent",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Original event"
},
{
"name": "value",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Unselected item"
}
]
},
{
"name": "dropdown-click",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke to when dropdown button is clicked.",
"arguments": [
{
"name": "originalEvent",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Original event"
},
{
"name": "query",
"doc-url": "https://primevue.org/autocomplete",
"type": "string",
"description": "Current value of the input field"
}
]
},
{
"name": "clear",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke when input is cleared by the user."
},
{
"name": "complete",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke to search for suggestions.",
"arguments": [
{
"name": "originalEvent",
"doc-url": "https://primevue.org/autocomplete",
"type": "object",
"description": "Original event"
},
{
"name": "query",
"doc-url": "https://primevue.org/autocomplete",
"type": "string",
"description": "Value to search with"
}
]
},
{
"name": "before-show",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke before the overlay is shown."
},
{
"name": "before-hide",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke before the overlay is hidden."
},
{
"name": "show",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke when the overlay is shown."
},
{
"name": "hide",
"doc-url": "https://primevue.org/autocomplete",
"description": "Callback to invoke when the overlay is hidden."
}
],
"slots": [
{
"name": "chip",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the chip display."
},
{
"name": "header",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the component header."
},
{
"name": "footer",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the component footer."
},
{
"name": "item",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the item."
},
{
"name": "option",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the item."
},
{
"name": "optiongroup",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the optiongroup item."
},
{
"name": "content",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the virtual scroller."
},
{
"name": "loader",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom content for the virtual scroller loader items."
},
{
"name": "empty",
"doc-url": "https://primevue.org/autocomplete",
"description": "Custom empty template when there is no data to display."
}
]
},
{
"name": "Avatar",
"source": {
"module": "PrimeVue",
"symbol": "Avatar"
},
"doc-url": "https://primevue.org/avatar",
"description": "Avatar represents people using icons, labels and images.",
"attributes": [
{
"name": "label",
"default": "null",
"doc-url": "https://primevue.org/avatar",
"description": "Defines the text to display.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "icon",
"default": "null",
"doc-url": "https://primevue.org/avatar",
"description": "Defines the icon to display.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "image",
"default": "null",
"doc-url": "https://primevue.org/avatar",
"description": "Defines the image to display.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "size",
"default": "null",
"doc-url": "https://primevue.org/avatar",
"description": "Size of the element, valid options are \"large\" and \"xlarge\".",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "shape",
"default": "square",
"doc-url": "https://primevue.org/avatar",
"description": "Shape of the element, valid options are \"square\" and \"circle\".",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"events": [
{
"name": "error",
"doc-url": "https://primevue.org/avatar",
"description": "Triggered when an error occurs while loading an image file."
}
]
},
{
"name": "AvatarGroup",
"source": {
"module": "PrimeVue",
"symbol": "AvatarGroup"
},
"doc-url": "https://primevue.org/avatar",
"description": "A set of Avatars can be displayed together using the AvatarGroup component."
},
{
"name": "Badge",
"source": {
"module": "PrimeVue",
"symbol": "Badge"
},
"doc-url": "https://primevue.org/badge",
"description": "Badge is a small status indicator for another element.",
"attributes": [
{
"name": "value",
"default": "null",
"doc-url": "https://primevue.org/badge",
"description": "Value to display inside the badge.",
"value": {
"kind": "expression",
"type": "string | number"
}
},
{
"name": "severity",
"default": "null",
"doc-url": "https://primevue.org/badge",
"description": "Severity type of the badge.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "size",
"default": "null",
"doc-url": "https://primevue.org/badge",
"description": "Size of the badge, valid options are \"large\" and \"xlarge\".",
"value": {
"kind": "expression",
"type": "string"
}
}
]
},
{
"name": "BadgeDirective",
"source": {
"module": "PrimeVue",
"symbol": "BadgeDirective"
},
"doc-url": "https://primevue.org/badgedirective",
"description": "When Badge used as a directive, badge needs to be configured at the application with a name of your choice."
},
{
"name": "BlockUI",
"source": {
"module": "PrimeVue",
"symbol": "BlockUI"
},
"doc-url": "https://primevue.org/blockui",
"description": "BlockUI can either block other components or the whole page.",
"attributes": [
{
"name": "blocked",
"default": "null",
"doc-url": "https://primevue.org/blockui",
"description": "Controls the blocked state.",
"value": {
"kind": "expression",
"type": "array"
}
},
{
"name": "fullscreen",
"default": "null",
"doc-url": "https://primevue.org/blockui",
"description": "When enabled, the whole document gets blocked.",
"value": {
"kind": "expression",
"type": "menuitem"
}
},
{
"name": "baseZIndex",
"default": "0",
"doc-url": "https://primevue.org/blockui",
"description": "Base zIndex value to use in layering.",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "autoZIndex",
"default": "true",
"doc-url": "https://primevue.org/blockui",
"description": "Whether to automatically manage layering.",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"events": [
{
"name": "block",
"doc-url": "https://primevue.org/blockui",
"description": "Fired when the element gets blocked."
},
{
"name": "unblock",
"doc-url": "https://primevue.org/blockui",
"description": "Fired when the element gets unblocked."
}
]
},
{
"name": "Breadcrumb",
"source": {
"module": "PrimeVue",
"symbol": "Breadcrumb"
},
"doc-url": "https://primevue.org/breadcrumb",
"description": "Breadcrumb provides contextual information about page hierarchy.",
"attributes": [
{
"name": "model",
"default": "null",
"doc-url": "https://primevue.org/breadcrumb",
"description": "An array of menuitems.",
"value": {
"kind": "expression",
"type": "array"
}
},
{
"name": "home",
"default": "null",
"doc-url": "https://primevue.org/breadcrumb",
"description": "Configuration for the home icon.",
"value": {
"kind": "expression",
"type": "menuitem"
}
},
{
"name": "exact",
"default": "true",
"doc-url": "https://primevue.org/breadcrumb",
"description": "Whether to apply 'router-link-active-exact' class if route exactly matches the item path.",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"slots": [
{
"name": "item",
"doc-url": "https://primevue.org/breadcrumb",
"description": "Template of a menuitem."
}
]
},
{
"name": "Button",
"source": {
"module": "PrimeVue",
"symbol": "Button"
},
"doc-url": "https://primevue.org/button",
"description": "Button is an extension to standard button element with icons and theming.",
"attributes": [
{
"name": "label",
"default": "null",
"doc-url": "https://primevue.org/button",
"description": "Text of the button.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "icon",
"default": "null",
"doc-url": "https://primevue.org/button",
"description": "Name of the icon.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "iconPos",
"default": "left",
"doc-url": "https://primevue.org/button",
"description": "Position of the icon, valid values are \"left\", \"right\", \"bottom\" and \"top\".",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "iconClass",
"default": "null",
"doc-url": "https://primevue.org/button",
"description": "Style class of the icon.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "badge",
"default": "null",
"doc-url": "https://primevue.org/button",
"description": "Value of the badge.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "badgeClass",
"default": "null",
"doc-url": "https://primevue.org/button",
"description": "Style class of the badge.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "loading",
"default": "false",
"doc-url": "https://primevue.org/button",
"description": "Whether the button is in loading state.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "loadingIcon",
"default": "pi pi-spinner pi-spin",
"doc-url": "https://primevue.org/button",
"description": "Icon to display in loading state.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "link",
"default": "false",
"doc-url": "https://primevue.org/button",
"description": "Add a link style to the button.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "severity",
"default": "null",
"doc-url": "https://primevue.org/button",
"description": "Defines the style of the button, valid values are \"secondary\", \"success\", \"info\", \"warning\", \"help\", \"danger\".",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "raised",
"default": "false",
"doc-url": "https://primevue.org/button",
"description": "Add a shadow to indicate elevation.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "rounded",
"default": "false",
"doc-url": "https://primevue.org/button",
"description": "Add a circular border radius to the button.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "text",
"default": "false",
"doc-url": "https://primevue.org/button",
"description": "Add a textual class to the button without a background initially.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "outlined",
"default": "false",
"doc-url": "https://primevue.org/button",
"description": "Add a border class without a background initially.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"default": "null",
"doc-url": "https://primevue.org/button",
"description": "Defines the size of the button, valid values are \"small\" and \"large\".",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "plain",
"default": "false",
"doc-url": "https://primevue.org/button",
"description": "Add a plain textual class to the button without a background initially.",
"value": {
"kind": "expression",
"type": "boolean"
}
}
]
},
{
"name": "Calendar",
"source": {
"module": "PrimeVue",
"symbol": "Calendar"
},
"doc-url": "https://primevue.org/calendar",
"description": "Calendar is an input component to select a date.",
"attributes": [
{
"name": "modelValue",
"default": "null",
"doc-url": "https://primevue.org/calendar",
"description": "Value of the component.",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "selectionMode",
"default": "single",
"doc-url": "https://primevue.org/calendar",
"description": "Defines the quantity of the selection, valid values are \"single\", \"multiple\" and \"range\".",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "dateFormat",
"default": "null",
"doc-url": "https://primevue.org/calendar",
"description": "Format of the date. Defaults to PrimeVue Locale configuration.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "inline",
"default": "false",
"doc-url": "https://primevue.org/calendar",
"description": "When enabled, displays the calendar as inline instead of an overlay.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "showOtherMonths",
"default": "true",
"doc-url": "https://primevue.org/calendar",
"description": "Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "selectOtherMonths",
"default": "false",
"doc-url": "https://primevue.org/calendar",
"description": "Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "showIcon",
"default": "false",
"doc-url": "https://primevue.org/calendar",
"description": "When enabled, displays a button with icon next to input.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"default": "pi pi-calendar",
"doc-url": "https://primevue.org/calendar",
"description": "Icon of the calendar button.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "numberOfMonths",
"default": "1",
"doc-url": "https://primevue.org/calendar",
"description": "Number of months to display.",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "view",
"default": "date",
"doc-url": "https://primevue.org/calendar",
"description": "Type of view to display, valid valids are \"date\" for datepicker and \"month\" for month picker.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "touchUI",
"default": "false",
"doc-url": "https://primevue.org/calendar",
"description": "When enabled, calendar overlay is displayed as optimized for touch devices.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "monthNavigator",
"default": "false",
"doc-url": "https://primevue.org/calendar",
"description": "Whether the month should be rendered as a dropdown instead of text.",
"value": {
"kind": "expression",
"typ