{
"v-alert/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-alert/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-alert/border": {
"type": "boolean | 'top' | 'end' | 'bottom' | 'start'\n",
"description": "Adds a colored border to the component."
},
"v-alert/border-color": {
"type": "string\n",
"description": "Specifies the color of the border. Accepts any color value."
},
"v-alert/closable": {
"type": "boolean\n",
"description": "Adds a close icon that can hide the alert."
},
"v-alert/close-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Change the default icon used for **closable** alerts."
},
"v-alert/type": {
"type": "'success' | 'info' | 'warning' | 'error'\n",
"description": "Create a specialized alert that uses a contextual color and has a pre-defined icon."
},
"v-alert/close-label": {
"type": "string\n",
"description": "Text used for *aria-label* on **closable** alerts. Can also be customized globally in [Internationalization](/customization/internationalization)."
},
"v-alert/icon": {
"type": " | false\n | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-alert/model-value": {
"type": "boolean\n",
"description": "Controls whether the component is visible or hidden."
},
"v-alert/prominent": {
"type": "boolean\n",
"description": "Displays a larger vertically centered icon to draw more attention."
},
"v-alert/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-alert/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-alert/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-alert/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-alert/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-alert/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-alert/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-alert/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-alert/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-alert/position": {
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-alert/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-alert/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-alert/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-alert/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-alert/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-alert-title/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-app/full-height": {
"type": "boolean\n",
"description": "Sets the component height to 100%."
},
"v-app/overlaps": {
"type": "string[]\n",
"description": "**FOR INTERNAL USE ONLY**"
},
"v-app/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-app-bar/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-app-bar/flat": {
"type": "boolean\n",
"description": "Removes the component's **box-shadow**."
},
"v-app-bar/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-app-bar/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-app-bar/density": {
"type": "'default' | 'prominent' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-app-bar/height": {
"type": "string | number\n",
"description": "Designates a specific height for the toolbar. Overrides the heights imposed by other props, e.g. **prominent**, **dense**, **extended**, etc."
},
"v-app-bar/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-app-bar/location": {
"type": "'top' | 'bottom'\n",
"description": "Aligns the component towards the top or bottom."
},
"v-app-bar/absolute": {
"type": "boolean\n",
"description": "Applies position: absolute to the component."
},
"v-app-bar/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-app-bar/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-app-bar/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-app-bar/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-app-bar/name": {
"type": "string\n",
"description": "Assign a specific name for layout registration."
},
"v-app-bar/image": {
"type": "string\n",
"description": "Specifies a [v-img](/components/images) as the component's background."
},
"v-app-bar/collapse": {
"type": "boolean\n",
"description": "Morphs the component into a collapsed state, reducing its maximum width."
},
"v-app-bar/extended": {
"type": "boolean\n",
"description": "Use this prop to increase the height of the toolbar _without_ using the `extension` slot for adding content. May be used in conjunction with the **extension-height** prop, and any of the other props that affect the height of the toolbar, e.g. **prominent**, **dense**, etc., **WITH THE EXCEPTION** of **height**."
},
"v-app-bar/extension-height": {
"type": "string | number\n",
"description": "Designate an explicit height for the `extension` slot."
},
"v-app-bar/floating": {
"type": "boolean\n",
"description": "Applies **display: inline-flex** to the component."
},
"v-app-bar/order": {
"type": "string | number\n",
"description": "Adjust the order of the component in relation to its registration order."
},
"v-app-bar/scroll-target": {
"type": "string\n",
"description": "The element to target for scrolling events. Uses `window` by default."
},
"v-app-bar/scroll-threshold": {
"type": "string | number\n",
"description": "The amount of scroll distance down before **scroll-behavior** activates."
},
"v-app-bar/scroll-behavior": {
"type": " | (string & {})\n | 'hide'\n | 'inverted'\n | 'collapse'\n | 'elevate'\n | 'fade-image'\n",
"description": "Specify an action to take when the scroll position of **scroll-target** reaches **scroll-threshold**. Accepts any combination of hide, inverted, collapse, elevate, and fade-image. Multiple values can be used, separated by a space."
},
"v-app-bar-nav-icon/symbol": {
"type": "any\n",
"description": "The [Symbol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) used to hook into group functionality for components like [v-btn-toggle](/components/btn-toggle) and [v-bottom-navigation](/components/bottom-navigations/)."
},
"v-app-bar-nav-icon/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-app-bar-nav-icon/flat": {
"type": "boolean\n",
"description": "Removes the button box shadow. This is different than using the 'flat' variant."
},
"v-app-bar-nav-icon/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-app-bar-nav-icon/icon": {
"type": " | boolean\n | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component. The button will become _round_."
},
"v-app-bar-nav-icon/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-app-bar-nav-icon/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-app-bar-nav-icon/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-app-bar-nav-icon/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-app-bar-nav-icon/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-app-bar-nav-icon/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-app-bar-nav-icon/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-app-bar-nav-icon/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-app-bar-nav-icon/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-app-bar-nav-icon/position": {
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-app-bar-nav-icon/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-app-bar-nav-icon/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-app-bar-nav-icon/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-app-bar-nav-icon/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-app-bar-nav-icon/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-app-bar-nav-icon/replace": {
"type": "boolean\n",
"description": "Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [replace](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
},
"v-app-bar-nav-icon/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-app-bar-nav-icon/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
},
"v-app-bar-nav-icon/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-app-bar-nav-icon/block": {
"type": "boolean\n",
"description": "Expands the button to 100% of available space."
},
"v-app-bar-nav-icon/slim": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VBtn.json))"
},
"v-app-bar-nav-icon/stacked": {
"type": "boolean\n",
"description": "Displays the button as a flex-column."
},
"v-app-bar-nav-icon/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-app-bar-nav-icon/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-app-bar-nav-icon/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-app-bar-nav-icon/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-app-bar-nav-icon/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-app-bar-nav-icon/href": {
"type": "string\n",
"description": "Designates the component as anchor and applies the **href** attribute."
},
"v-app-bar-nav-icon/exact": {
"type": "boolean\n",
"description": "Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation."
},
"v-app-bar-nav-icon/to": {
"type": "RouteLocationRaw\n",
"description": "Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation."
},
"v-app-bar-nav-icon/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-app-bar-title/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-app-bar-title/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-autocomplete/flat": {
"type": "boolean\n",
"description": "Removes box shadow when using a variant with elevation."
},
"v-autocomplete/type": {
"type": "string\n",
"description": "Sets input type."
},
"v-autocomplete/reverse": {
"type": "boolean\n",
"description": "Reverses the orientation."
},
"v-autocomplete/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-autocomplete/search": {
"type": "string\n",
"description": "Text input used to filter items."
},
"v-autocomplete/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-autocomplete/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-autocomplete/items": {
"type": "any[]\n",
"description": "Can be an array of objects or strings. By default objects should have **title** and **value** properties, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props). Keys to use for these can be changed with the **item-title**, **item-value**, and **item-props** props."
},
"v-autocomplete/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-autocomplete/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-autocomplete/auto-select-first": {
"type": "boolean | 'exact'\n",
"description": "When searching, will always highlight the first option and select it on blur. `exact` will only highlight and select exact matches."
},
"v-autocomplete/filter-mode": {
"type": "'every' | 'some' | 'union' | 'intersection'\n",
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
},
"v-autocomplete/no-filter": {
"type": "boolean\n",
"description": "Do not apply filtering when searching. Useful when data is being filtered server side."
},
"v-autocomplete/custom-filter": {
"type": "FilterFunction\n",
"description": "Function used to filter items, called for each filterable key on each item in the list. The first argument is the filterable value from the item, the second is the search term, and the third is the internal item object. The function should return true if the item should be included in the filtered list, or the index of the match in the value if it should be included with the result highlighted."
},
"v-autocomplete/custom-key-filter": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
},
"v-autocomplete/filter-keys": {
"type": "string | string[]\n",
"description": "Array of specific keys to filter on the item."
},
"v-autocomplete/chips": {
"type": "boolean\n",
"description": "Changes display of selections to chips."
},
"v-autocomplete/closable-chips": {
"type": "boolean\n",
"description": "Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components."
},
"v-autocomplete/close-text": {
"type": "string\n",
"description": "Text set to to the inputs `aria-label` and `title` when input menu is closed."
},
"v-autocomplete/open-text": {
"type": "string\n",
"description": "Text set to to the inputs **aria-label** and **title** when input menu is open."
},
"v-autocomplete/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-autocomplete/hide-no-data": {
"type": "boolean\n",
"description": "Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open."
},
"v-autocomplete/hide-selected": {
"type": "boolean\n",
"description": "Do not display in the select menu items that are already selected."
},
"v-autocomplete/menu": {
"type": "boolean\n",
"description": "Renders with the menu open by default."
},
"v-autocomplete/menu-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Sets the the spin icon."
},
"v-autocomplete/menu-props": {
"type": "unknown\n",
"description": "Pass props through to the `v-menu` component. Accepts an object with anything from [v-menu](/api/v-menu/#props) props, camelCase keys are recommended."
},
"v-autocomplete/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-autocomplete/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-autocomplete/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-autocomplete/multiple": {
"type": "boolean\n",
"description": "Changes select to multiple. Accepts array for value."
},
"v-autocomplete/no-data-text": {
"type": "string\n",
"description": "Text shown when no items are provided to the component."
},
"v-autocomplete/open-on-clear": {
"type": "boolean\n",
"description": "Open's the menu whenever the clear icon is clicked."
},
"v-autocomplete/item-color": {
"type": "string\n",
"description": "Sets color of selected items."
},
"v-autocomplete/item-title": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its title."
},
"v-autocomplete/item-value": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its value."
},
"v-autocomplete/item-children": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its children."
},
"v-autocomplete/item-props": {
"type": "SelectItemKey\n",
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
},
"v-autocomplete/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-autocomplete/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-autocomplete/autofocus": {
"type": "boolean\n",
"description": "Enables autofocus."
},
"v-autocomplete/counter": {
"type": "string | number | boolean\n",
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
},
"v-autocomplete/prefix": {
"type": "string\n",
"description": "Displays prefix text."
},
"v-autocomplete/placeholder": {
"type": "string\n",
"description": "Sets the input’s placeholder text."
},
"v-autocomplete/persistent-placeholder": {
"type": "boolean\n",
"description": "Forces placeholder to always be visible."
},
"v-autocomplete/persistent-counter": {
"type": "boolean\n",
"description": "Forces counter to always be visible."
},
"v-autocomplete/suffix": {
"type": "string\n",
"description": "Displays suffix text."
},
"v-autocomplete/role": {
"type": "string\n",
"description": "The role attribute applied to the input."
},
"v-autocomplete/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-autocomplete/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-autocomplete/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
},
"v-autocomplete/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-autocomplete/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-autocomplete/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-autocomplete/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-autocomplete/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-autocomplete/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-autocomplete/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-autocomplete/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-autocomplete/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-autocomplete/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-autocomplete/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-autocomplete/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-autocomplete/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-autocomplete/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-autocomplete/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared."
},
"v-autocomplete/clear-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when the **clearable** prop is set to true."
},
"v-autocomplete/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-autocomplete/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-autocomplete/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-autocomplete/persistent-clear": {
"type": "boolean\n",
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
},
"v-autocomplete/prepend-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
},
"v-autocomplete/single-line": {
"type": "boolean\n",
"description": "Label does not move on focus/dirty."
},
"v-autocomplete/variant": {
"type": " | 'underlined'\n | 'outlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-autocomplete/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-autocomplete/rounded": {
"type": "string | number | boolean\n",
"description": "Adds a border radius to the input."
},
"v-autocomplete/counter-value": {
"type": "number | ((value: any) => number)\n",
"description": "Function returns the counter display text."
},
"v-autocomplete/model-modifiers": {
"type": "unknown\n",
"description": "**FOR INTERNAL USE ONLY**"
},
"v-avatar/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-avatar/end": {
"type": "boolean\n",
"description": "Applies margin at the start of the component."
},
"v-avatar/start": {
"type": "boolean\n",
"description": "Applies margin at the end of the component."
},
"v-avatar/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-avatar/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-avatar/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-avatar/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-avatar/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-avatar/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-avatar/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-avatar/image": {
"type": "string\n",
"description": "Apply a specific image using [v-img](/components/images/)."
},
"v-avatar/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-badge/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-badge/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-badge/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-badge/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-badge/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-badge/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-badge/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-badge/floating": {
"type": "boolean\n",
"description": "Elevates the badge above the slotted content."
},
"v-badge/bordered": {
"type": "boolean\n",
"description": "Applies a **2px** by default and **1.5px** border around the badge when using the **dot** property."
},
"v-badge/content": {
"type": "string | number\n",
"description": "Text content to show in the badge."
},
"v-badge/dot": {
"type": "boolean\n",
"description": "Reduce the size of the badge and hide its contents."
},
"v-badge/inline": {
"type": "boolean\n",
"description": "Moves the badge to be inline with the wrapping element. Supports the usage of the **left** prop."
},
"v-badge/label": {
"type": "string\n",
"description": "The **aria-label** used for the badge."
},
"v-badge/max": {
"type": "string | number\n",
"description": "Sets the maximum number allowed when using the **content** prop with a `number` like value. If the content number exceeds the maximum value, a `+` suffix is added."
},
"v-badge/offset-x": {
"type": "string | number\n",
"description": "Offset the badge on the x-axis."
},
"v-badge/offset-y": {
"type": "string | number\n",
"description": "Offset the badge on the y-axis."
},
"v-badge/text-color": {
"type": "string\n",
"description": "Applies a specified color to the control text - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-badge/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-banner/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-banner/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-banner/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-banner/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-banner/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-banner/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-banner/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-banner/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-banner/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-banner/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-banner/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-banner/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-banner/position": {
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-banner/sticky": {
"type": "boolean\n",
"description": "Applies `position: sticky` to the component with `top: 0`. You can find more information on the [MDN documentation for sticky position](https://developer.mozilla.org/en-US/docs/Web/CSS/position)."
},
"v-banner/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-banner/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-banner/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-banner/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-banner/stacked": {
"type": "boolean\n",
"description": "Forces the banner actions onto a new line. This is not applicable when the banner has `lines=\"one\"`."
},
"v-banner/avatar": {
"type": "string\n",
"description": "Designates a specific src image to pass to the thumbnail."
},
"v-banner/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-banner/mobile-breakpoint": {
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/display.json))"
},
"v-banner/lines": {
"type": "'one' | 'two' | 'three'\n",
"description": "The amount of visible lines of text before it truncates."
},
"v-banner-actions/density": {
"type": "string\n",
"description": "Adjusts the vertical height used by the component."
},
"v-banner-actions/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-banner-text/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-bottom-navigation/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-bottom-navigation/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-bottom-navigation/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-bottom-navigation/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-bottom-navigation/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-bottom-navigation/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the component."
},
"v-bottom-navigation/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-bottom-navigation/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-bottom-navigation/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-bottom-navigation/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-bottom-navigation/name": {
"type": "string\n",
"description": "Assign a specific name for layout registration."
},
"v-bottom-navigation/order": {
"type": "string | number\n",
"description": "Adjust the order of the component in relation to its registration order."
},
"v-bottom-navigation/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-bottom-navigation/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-bottom-navigation/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-bottom-navigation/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-bottom-navigation/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-bottom-navigation/grow": {
"type": "boolean\n",
"description": "Force all [v-btn](/components/buttons) children to take up all available horizontal space."
},
"v-bottom-navigation/mode": {
"type": "string\n",
"description": "Changes the orientation and active state styling of the component."
},
"v-bottom-navigation/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-bottom-navigation/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-bottom-sheet/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-bottom-sheet/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-bottom-sheet/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-bottom-sheet/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-bottom-sheet/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-bottom-sheet/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-bottom-sheet/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-bottom-sheet/location": {
"type": "Anchor\n",
"description": "Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both.."
},
"v-bottom-sheet/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the content element."
},
"v-bottom-sheet/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-bottom-sheet/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-bottom-sheet/transition": {
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-bottom-sheet/activator": {
"type": "(string & {}) | Element | 'parent' | ComponentPublicInstance\n",
"description": "Explicitly sets the overlay's activator."
},
"v-bottom-sheet/inset": {
"type": "boolean\n",
"description": "Reduces the sheet content maximum width to 70%."
},
"v-bottom-sheet/fullscreen": {
"type": "boolean\n",
"description": "Changes layout for fullscreen display."
},
"v-bottom-sheet/retain-focus": {
"type": "boolean\n",
"description": "Tab focus will return to the first child of the dialog by default. Disable this when using external tools that require focus such as TinyMCE or vue-clipboard."
},
"v-bottom-sheet/scrollable": {
"type": "boolean\n",
"description": "When set to true, expects a `v-card` and a `v-card-text` component with a designated height. For more information, check out the [scrollable example](/components/dialogs#scrollable)."
},
"v-bottom-sheet/close-on-back": {
"type": "boolean\n",
"description": "Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing."
},
"v-bottom-sheet/contained": {
"type": "boolean\n",
"description": "Limits the size of the component and scrim to its offset parent. Implies `absolute` and `attach`. (Note: The parent element must have position: relative.)."
},
"v-bottom-sheet/content-class": {
"type": "any\n",
"description": "Applies a custom class to the detached element. This is useful because the content is moved to the beginning of the `v-app` component (unless the **attach** prop is provided) and is not targetable by classes passed directly on the component."
},
"v-bottom-sheet/content-props": {
"type": "any\n",
"description": "Apply custom properties to the content."
},
"v-bottom-sheet/no-click-animation": {
"type": "boolean\n",
"description": "Disables the bounce effect when clicking outside of the content element when using the persistent prop."
},
"v-bottom-sheet/persistent": {
"type": "boolean\n",
"description": "Clicking outside of the element or pressing esc key will not deactivate it."
},
"v-bottom-sheet/scrim": {
"type": "string | boolean\n",
"description": "Accepts true/false to enable background, and string to define color."
},
"v-bottom-sheet/z-index": {
"type": "string | number\n",
"description": "The z-index used for the component."
},
"v-bottom-sheet/target": {
"type": " | (string & {})\n | Element\n | 'parent'\n | 'cursor'\n | ComponentPublicInstance\n | [number, number]\n",
"description": "For locationStrategy=\"connected\", specify an element or array of x,y coordinates that the overlay should position itself relative to. This will be the activator element by default."
},
"v-bottom-sheet/activator-props": {
"type": "unknown\n",
"description": "Apply custom properties to the activator."
},
"v-bottom-sheet/open-on-click": {
"type": "boolean\n",
"description": "Activate the component when the activator is clicked."
},
"v-bottom-sheet/open-on-hover": {
"type": "boolean\n",
"description": "Designates whether component should activate when its activator is hovered."
},
"v-bottom-sheet/open-on-focus": {
"type": "boolean\n",
"description": "Activate the component when the activator is focused."
},
"v-bottom-sheet/close-on-content-click": {
"type": "boolean\n",
"description": "Closes component when you click on its content."
},
"v-bottom-sheet/close-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before closing component. Only applies to hover and focus events."
},
"v-bottom-sheet/open-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before opening component. Only applies to hover and focus events."
},
"v-bottom-sheet/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-bottom-sheet/location-strategy": {
"type": "'static' | 'connected' | LocationStrategyFn\n",
"description": "A function used to specifies how the component should position relative to its activator."
},
"v-bottom-sheet/origin": {
"type": "Anchor | 'auto' | 'overlap'\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-bottom-sheet/offset": {
"type": "string | number | number[]\n",
"description": "A single value that offsets content away from the target based upon what side it is on."
},
"v-bottom-sheet/scroll-strategy": {
"type": "'close' | 'block' | 'none' | 'reposition' | ScrollStrategyFn\n",
"description": "Strategy used when the component is activate and user scrolls."
},
"v-bottom-sheet/attach": {
"type": "string | boolean | Element\n",
"description": "Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default."
},
"v-breadcrumbs/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-breadcrumbs/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-breadcrumbs/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-breadcrumbs/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-breadcrumbs/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-breadcrumbs/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-breadcrumbs/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-breadcrumbs/divider": {
"type": "string\n",
"description": "Specifies the dividing character between items."
},
"v-breadcrumbs/active-class": {
"type": "string\n",
"description": "The class applied to the component when it is in an active state."
},
"v-breadcrumbs/active-color": {
"type": "string\n",
"description": "The applied color when the component is in an active state."
},
"v-breadcrumbs/items": {
"type": "(\n | string\n | (Partial & { title: string; disabled: boolean })\n)[]\n",
"description": "An array of strings or objects used for automatically generating children components."
},
"v-breadcrumbs-divider/divider": {
"type": "string | number\n",
"description": "Specifies the dividing character between items."
},
"v-breadcrumbs-item/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-breadcrumbs-item/replace": {
"type": "boolean\n",
"description": "Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [replace](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
},
"v-breadcrumbs-item/exact": {
"type": "boolean\n",
"description": "Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation."
},
"v-breadcrumbs-item/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-breadcrumbs-item/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-breadcrumbs-item/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-breadcrumbs-item/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-breadcrumbs-item/active-class": {
"type": "string\n",
"description": "The class applied to the component when it matches the current route. Find more information about the [active-class prop](https://router.vuejs.org/api/#active-class) on the [vue-router](https://router.vuejs.org/) documentation."
},
"v-breadcrumbs-item/active-color": {
"type": "string\n",
"description": "The applied color when the component is in an active state."
},
"v-breadcrumbs-item/href": {
"type": "string\n",
"description": "Designates the component as anchor and applies the **href** attribute."
},
"v-breadcrumbs-item/to": {
"type": "RouteLocationRaw\n",
"description": "Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation."
},
"v-btn/symbol": {
"type": "any\n",
"description": "The [Symbol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) used to hook into group functionality for components like [v-btn-toggle](/components/btn-toggle) and [v-bottom-navigation](/components/bottom-navigations/)."
},
"v-btn/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-btn/flat": {
"type": "boolean\n",
"description": "Removes the button box shadow. This is different than using the 'flat' variant."
},
"v-btn/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-btn/icon": {
"type": " | boolean\n | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component. The button will become _round_."
},
"v-btn/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-btn/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-btn/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-btn/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-btn/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-btn/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-btn/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-btn/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-btn/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-btn/position": {
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-btn/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-btn/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-btn/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-btn/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-btn/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-btn/replace": {
"type": "boolean\n",
"description": "Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [replace](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
},
"v-btn/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-btn/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
},
"v-btn/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-btn/block": {
"type": "boolean\n",
"description": "Expands the button to 100% of available space."
},
"v-btn/slim": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VBtn.json))"
},
"v-btn/stacked": {
"type": "boolean\n",
"description": "Displays the button as a flex-column."
},
"v-btn/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-btn/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-btn/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-btn/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-btn/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-btn/href": {
"type": "string\n",
"description": "Designates the component as anchor and applies the **href** attribute."
},
"v-btn/exact": {
"type": "boolean\n",
"description": "Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation."
},
"v-btn/to": {
"type": "RouteLocationRaw\n",
"description": "Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation."
},
"v-btn/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-btn-group/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-btn-group/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-btn-group/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-btn-group/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-btn-group/variant": {
"type": "'flat' | 'text' | 'outlined' | 'plain' | 'elevated' | 'tonal'\n",
"description": "Applies a distinct style to the component."
},
"v-btn-group/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-btn-group/divided": {
"type": "boolean\n",
"description": "Add dividers between children [v-btn](/components/buttons) components."
},
"v-btn-group/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-btn-group/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-btn-toggle/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-btn-toggle/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-btn-toggle/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-btn-toggle/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-btn-toggle/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-btn-toggle/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-btn-toggle/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-btn-toggle/variant": {
"type": "'flat' | 'text' | 'outlined' | 'plain' | 'elevated' | 'tonal'\n",
"description": "Applies a distinct style to the component."
},
"v-btn-toggle/rounded": {
"type": "string | number | boolean\n",
"description": "Round edge buttons."
},
"v-btn-toggle/divided": {
"type": "boolean\n",
"description": "Add dividers between children [v-btn](/components/buttons) components."
},
"v-btn-toggle/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-btn-toggle/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-btn-toggle/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-btn-toggle/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-btn-toggle/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-card/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-card/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-card/flat": {
"type": "boolean\n",
"description": "Removes the card's elevation."
},
"v-card/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-card/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-card/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-card/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-card/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-card/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-card/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-card/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-card/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-card/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-card/position": {
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-card/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-card/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-card/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-card/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-card/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-card/replace": {
"type": "boolean\n",
"description": "Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [replace](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
},
"v-card/link": {
"type": "boolean\n",
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
},
"v-card/image": {
"type": "string\n",
"description": "Apply a specific background image to the component."
},
"v-card/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends a [v-icon](/components/icons/) component to the header."
},
"v-card/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-card/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-card/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-card/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-card/href": {
"type": "string\n",
"description": "Designates the component as anchor and applies the **href** attribute."
},
"v-card/exact": {
"type": "boolean\n",
"description": "Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation."
},
"v-card/to": {
"type": "RouteLocationRaw\n",
"description": "Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation."
},
"v-card/subtitle": {
"type": "string\n",
"description": "Specify a subtitle text for the component."
},
"v-card/append-avatar": {
"type": "string\n",
"description": "Appends a [v-avatar](/components/avatars/) component after default content in the **append** slot."
},
"v-card/hover": {
"type": "boolean\n",
"description": "Applies **4dp** of elevation when hovered (default 2dp). You can find more information on the [elevation page](/styles/elevation)."
},
"v-card/prepend-avatar": {
"type": "string\n",
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
},
"v-card-item/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-card-item/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-card-item/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
},
"v-card-item/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-card-item/subtitle": {
"type": "string\n",
"description": "Specify a subtitle text for the component."
},
"v-card-item/append-avatar": {
"type": "string\n",
"description": "Appends a [v-avatar](/components/avatars/) component after default content in the **append** slot."
},
"v-card-item/prepend-avatar": {
"type": "string\n",
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
},
"v-card-subtitle/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-card-text/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-card-title/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-carousel/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-carousel/reverse": {
"type": "boolean\n",
"description": "Reverse the normal transition direction."
},
"v-carousel/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-carousel/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-carousel/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-carousel/color": {
"type": "string\n",
"description": "Applies a color to the navigation dots - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-carousel/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-carousel/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-carousel/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-carousel/cycle": {
"type": "boolean\n",
"description": "Determines if the carousel should cycle through images."
},
"v-carousel/delimiter-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Sets icon for carousel delimiter."
},
"v-carousel/hide-delimiters": {
"type": "boolean\n",
"description": "Hides the carousel's bottom delimiters."
},
"v-carousel/hide-delimiter-background": {
"type": "boolean\n",
"description": "Hides the bottom delimiter background."
},
"v-carousel/interval": {
"type": "string | number\n",
"description": "The duration between image cycles. Requires the **cycle** prop."
},
"v-carousel/progress": {
"type": "string | boolean\n",
"description": "Displays a carousel progress bar. Requires the **cycle** prop and **interval**."
},
"v-carousel/continuous": {
"type": "boolean\n",
"description": "Determines whether carousel is continuous."
},
"v-carousel/next-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The displayed icon for forcing pagination to the next item."
},
"v-carousel/prev-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The displayed icon for forcing pagination to the previous item."
},
"v-carousel/show-arrows": {
"type": "string | boolean\n",
"description": "Displays arrows for next/previous navigation."
},
"v-carousel/touch": {
"type": "boolean | TouchHandlers\n",
"description": "Provide a custom **left** and **right** function when swiped left or right."
},
"v-carousel/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "The transition direction when changing windows."
},
"v-carousel/vertical-delimiters": {
"type": "boolean | 'left' | 'right'\n",
"description": "Displays carousel delimiters vertically."
},
"v-carousel-item/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-carousel-item/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-carousel-item/content-class": {
"type": "string\n",
"description": "Apply a custom class to the internal content element."
},
"v-carousel-item/disabled": {
"type": "boolean\n",
"description": "Prevents the item from becoming active when using the \"next\" and \"prev\" buttons or the `toggle` method."
},
"v-carousel-item/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-carousel-item/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-carousel-item/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-carousel-item/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-carousel-item/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-carousel-item/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-carousel-item/transition": {
"type": "string | boolean\n",
"description": "The transition used when the component progressing through items. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-carousel-item/options": {
"type": "IntersectionObserverInit\n",
"description": "Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor."
},
"v-carousel-item/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-carousel-item/alt": {
"type": "string\n",
"description": "Alternate text for screen readers. Leave empty for decorative images."
},
"v-carousel-item/cover": {
"type": "boolean\n",
"description": "Resizes the background image to cover the entire container."
},
"v-carousel-item/draggable": {
"type": "boolean | 'true' | 'false'\n",
"description": "Controls the `draggable` behavior of the image. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/draggable)."
},
"v-carousel-item/gradient": {
"type": "string\n",
"description": "The gradient to apply to the image. This can be any valid CSS gradient declaration. You can find more information on the [MDN documentation for gradients](https://developer.mozilla.org/en-US/docs/Web/CSS/gradient)."
},
"v-carousel-item/lazy-src": {
"type": "string\n",
"description": "Something to show while waiting for the main image to load, typically a small base64-encoded thumbnail. Has a slight blur filter applied.\n\nUse [vuetify-loader](https://github.com/vuetifyjs/vuetify-loader) to generate automatically. NOTE: This prop has no effect unless either `height` or `aspect-ratio` are provided."
},
"v-carousel-item/sizes": {
"type": "string\n",
"description": "For use with `srcset`, see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)."
},
"v-carousel-item/src": {
"type": " | string\n | { src: string; srcset: string; lazySrc: string; aspect: number }\n",
"description": "The image URL. This prop is mandatory."
},
"v-carousel-item/srcset": {
"type": "string\n",
"description": "A set of alternate images to use based on device size. [Read more...](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset)."
},
"v-carousel-item/position": {
"type": "string\n",
"description": "Applies [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) styles to the image and placeholder elements."
},
"v-carousel-item/aspect-ratio": {
"type": "string | number\n",
"description": "Sets a base aspect ratio, calculated as width/height. This will only set a **minimum** height, the component can still grow if it has a lot of content."
},
"v-carousel-item/inline": {
"type": "boolean\n",
"description": "Display as an inline element instead of a block, also disables flex-grow."
},
"v-carousel-item/crossorigin": {
"type": "'' | 'anonymous' | 'use-credentials'\n",
"description": "Specify that images should be fetched with CORS enabled [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#crossorigin)"
},
"v-carousel-item/referrerpolicy": {
"type": " | 'origin'\n | 'no-referrer'\n | 'no-referrer-when-downgrade'\n | 'origin-when-cross-origin'\n | 'same-origin'\n | 'strict-origin'\n | 'strict-origin-when-cross-origin'\n | 'unsafe-url'\n",
"description": "Define which referrer is sent when fetching the resource [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#referrerpolicy)"
},
"v-carousel-item/reverse-transition": {
"type": "string | boolean\n",
"description": "Sets the reverse transition."
},
"v-checkbox/type": {
"type": "string\n",
"description": "Provides the default type for children selection controls."
},
"v-checkbox/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-checkbox/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-checkbox/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-checkbox/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-checkbox/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-checkbox/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-checkbox/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-checkbox/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-checkbox/multiple": {
"type": "boolean\n",
"description": "Changes expected model to an array."
},
"v-checkbox/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-checkbox/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-checkbox/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-checkbox/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-checkbox/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-checkbox/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-checkbox/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-checkbox/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-checkbox/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-checkbox/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-checkbox/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-checkbox/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-checkbox/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-checkbox/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-checkbox/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-checkbox/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-checkbox/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-checkbox/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-checkbox/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-checkbox/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSelectionControl.json))"
},
"v-checkbox/indeterminate": {
"type": "boolean\n",
"description": "Sets an indeterminate state for the checkbox."
},
"v-checkbox/indeterminate-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when in an indeterminate state."
},
"v-checkbox/true-value": {
"type": "any\n",
"description": "Sets value for truthy state."
},
"v-checkbox/false-value": {
"type": "any\n",
"description": "Sets value for falsy state."
},
"v-checkbox/defaults-target": {
"type": "string\n",
"description": "The target component to provide defaults values for."
},
"v-checkbox/false-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when inactive."
},
"v-checkbox/true-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when active."
},
"v-checkbox/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-checkbox-btn/type": {
"type": "string\n",
"description": "Provides the default type for children selection controls."
},
"v-checkbox-btn/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-checkbox-btn/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-checkbox-btn/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-checkbox-btn/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-checkbox-btn/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-checkbox-btn/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-checkbox-btn/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-checkbox-btn/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-checkbox-btn/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-checkbox-btn/inline": {
"type": "boolean\n",
"description": "Puts children inputs into a row."
},
"v-checkbox-btn/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-checkbox-btn/multiple": {
"type": "boolean\n",
"description": "Changes select to multiple. Accepts array for value."
},
"v-checkbox-btn/indeterminate": {
"type": "boolean\n",
"description": "Puts the control in an indeterminate state. Used with the [indeterminate-icon](#props-indeterminate-icon) property."
},
"v-checkbox-btn/indeterminate-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used when the component is in an indeterminate state."
},
"v-checkbox-btn/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSelectionControl.json))"
},
"v-checkbox-btn/true-value": {
"type": "any\n",
"description": "Sets value for truthy state."
},
"v-checkbox-btn/false-value": {
"type": "any\n",
"description": "Sets value for falsy state."
},
"v-checkbox-btn/defaults-target": {
"type": "string\n",
"description": "The target component to provide defaults values for."
},
"v-checkbox-btn/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-checkbox-btn/false-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when inactive."
},
"v-checkbox-btn/true-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when active."
},
"v-checkbox-btn/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-checkbox-btn/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-chip/filter": {
"type": "boolean\n",
"description": "Displays a selection icon when selected."
},
"v-chip/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-chip/replace": {
"type": "boolean\n",
"description": "Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [replace](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
},
"v-chip/link": {
"type": "boolean\n",
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
},
"v-chip/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-chip/value": {
"type": "any\n",
"description": "The value used when a child of a [v-chip-group](/components/chip-groups)."
},
"v-chip/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-chip/label": {
"type": "boolean\n",
"description": "Applies a medium size border radius."
},
"v-chip/exact": {
"type": "boolean\n",
"description": "Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation."
},
"v-chip/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-chip/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-chip/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-chip/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
},
"v-chip/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-chip/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-chip/variant": {
"type": "'flat' | 'text' | 'outlined' | 'plain' | 'elevated' | 'tonal'\n",
"description": "Applies a distinct style to the component."
},
"v-chip/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-chip/active-class": {
"type": "string\n",
"description": "The class applied to the component when it matches the current route. Find more information about the [active-class prop](https://router.vuejs.org/api/#active-class) on the [vue-router](https://router.vuejs.org/) documentation."
},
"v-chip/href": {
"type": "string\n",
"description": "Designates the component as anchor and applies the **href** attribute."
},
"v-chip/to": {
"type": "RouteLocationRaw\n",
"description": "Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation."
},
"v-chip/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-chip/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-chip/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-chip/append-avatar": {
"type": "string\n",
"description": "Appends a [v-avatar](/components/avatars/) component after default content in the **append** slot."
},
"v-chip/prepend-avatar": {
"type": "string\n",
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
},
"v-chip/draggable": {
"type": "boolean\n",
"description": "Makes the chip draggable."
},
"v-chip/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-chip/closable": {
"type": "boolean\n",
"description": "Adds remove button and then a chip can be closed."
},
"v-chip/close-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Change the default icon used for **close** chips."
},
"v-chip/close-label": {
"type": "string\n",
"description": "Text used for *aria-label* on the close button in **close** chips. Can also be customized globally in [Internationalization](/customization/internationalization)."
},
"v-chip/filter-icon": {
"type": "string\n",
"description": "Change the default icon used for **filter** chips."
},
"v-chip/pill": {
"type": "boolean\n",
"description": "Remove `v-avatar` padding."
},
"v-chip/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-chip-group/filter": {
"type": "boolean\n",
"description": "Applies an checkmark icon in front of every chip for using it like a filter."
},
"v-chip-group/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-chip-group/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-chip-group/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-chip-group/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-chip-group/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-chip-group/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-chip-group/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-chip-group/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-chip-group/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-chip-group/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-chip-group/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-chip-group/column": {
"type": "boolean\n",
"description": "Remove horizontal pagination and wrap items as needed."
},
"v-class-icon/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-class-icon/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-code/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-col/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-col/order": {
"type": "string | number\n",
"description": "Sets the default [order](https://developer.mozilla.org/en-US/docs/Web/CSS/order) for the column."
},
"v-col/sm": {
"type": "string | number | boolean\n",
"description": "Changes the number of columns on small and greater breakpoints."
},
"v-col/md": {
"type": "string | number | boolean\n",
"description": "Changes the number of columns on medium and greater breakpoints."
},
"v-col/lg": {
"type": "string | number | boolean\n",
"description": "Changes the number of columns on large and greater breakpoints."
},
"v-col/xl": {
"type": "string | number | boolean\n",
"description": "Changes the number of columns on extra large and greater breakpoints."
},
"v-col/xxl": {
"type": "string | number | boolean\n",
"description": "Changes the number of columns on extra extra large and greater breakpoints."
},
"v-col/offset": {
"type": "string | number\n",
"description": "Sets the default offset for the column."
},
"v-col/cols": {
"type": "string | number | boolean\n",
"description": "Sets the default number of columns the component extends. Available options are: **1 -> 12** and **auto**."
},
"v-col/offset-sm": {
"type": "string | number\n",
"description": "Changes the offset of the component on small and greater breakpoints."
},
"v-col/offset-md": {
"type": "string | number\n",
"description": "Changes the offset of the component on medium and greater breakpoints."
},
"v-col/offset-lg": {
"type": "string | number\n",
"description": "Changes the offset of the component on large and greater breakpoints."
},
"v-col/offset-xl": {
"type": "string | number\n",
"description": "Changes the offset of the component on extra large and greater breakpoints."
},
"v-col/offset-xxl": {
"type": "string | number\n",
"description": "Changes the offset of the component on extra extra large and greater breakpoints."
},
"v-col/order-sm": {
"type": "string | number\n",
"description": "Changes the order of the component on small and greater breakpoints."
},
"v-col/order-md": {
"type": "string | number\n",
"description": "Changes the order of the component on medium and greater breakpoints."
},
"v-col/order-lg": {
"type": "string | number\n",
"description": "Changes the order of the component on large and greater breakpoints."
},
"v-col/order-xl": {
"type": "string | number\n",
"description": "Changes the order of the component on extra large and greater breakpoints."
},
"v-col/order-xxl": {
"type": "string | number\n",
"description": "Changes the order of the component on extra extra large and greater breakpoints."
},
"v-col/align-self": {
"type": "'end' | 'start' | 'center' | 'auto' | 'baseline' | 'stretch'\n",
"description": "Applies the [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) css property. Available options are: **start**, **center**, **end**, **auto**, **baseline** and **stretch**."
},
"v-color-picker/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-color-picker/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-color-picker/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-color-picker/model-value": {
"type": "string | Record\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-color-picker/width": {
"type": "string | number\n",
"description": "Sets the width of the color picker."
},
"v-color-picker/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-color-picker/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-color-picker/mode": {
"type": "'rgb' | 'rgba' | 'hsl' | 'hsla' | 'hex' | 'hexa'\n",
"description": "The current selected input type. Syncable with `v-model:mode`."
},
"v-color-picker/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-color-picker/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-color-picker/position": {
"type": "'fixed' | 'relative' | 'absolute' | 'static' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-color-picker/canvas-height": {
"type": "string | number\n",
"description": "Height of canvas."
},
"v-color-picker/dot-size": {
"type": "string | number\n",
"description": "Changes the size of the selection dot on the canvas."
},
"v-color-picker/hide-canvas": {
"type": "boolean\n",
"description": "Hides canvas."
},
"v-color-picker/hide-sliders": {
"type": "boolean\n",
"description": "Hides sliders."
},
"v-color-picker/hide-inputs": {
"type": "boolean\n",
"description": "Hides inputs."
},
"v-color-picker/modes": {
"type": "('rgb' | 'rgba' | 'hsl' | 'hsla' | 'hex' | 'hexa')[]\n",
"description": "Sets available input types."
},
"v-color-picker/show-swatches": {
"type": "boolean\n",
"description": "Displays color swatches."
},
"v-color-picker/swatches-max-height": {
"type": "string | number\n",
"description": "Sets the maximum height of the swatches section."
},
"v-color-picker/swatches": {
"type": "(\n | string\n | number\n | {\n readonly h: number\n readonly s: number\n readonly v: number\n readonly a?: number | undefined\n }\n | {\n readonly r: number\n readonly g: number\n readonly b: number\n readonly a?: number | undefined\n }\n | {\n readonly h: number\n readonly s: number\n readonly l: number\n readonly a?: number | undefined\n }\n)[][]\n",
"description": "Sets the available color swatches to select from. 2D array of rows and columns, accepts any color format the picker does."
},
"v-combobox/flat": {
"type": "boolean\n",
"description": "Removes box shadow when using a variant with elevation."
},
"v-combobox/type": {
"type": "string\n",
"description": "Sets input type."
},
"v-combobox/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-combobox/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-combobox/reverse": {
"type": "boolean\n",
"description": "Reverses the orientation."
},
"v-combobox/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-combobox/rounded": {
"type": "string | number | boolean\n",
"description": "Adds a border radius to the input."
},
"v-combobox/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-combobox/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-combobox/variant": {
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
"description": "Applies a distinct style to the component."
},
"v-combobox/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-combobox/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-combobox/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
},
"v-combobox/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-combobox/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-combobox/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-combobox/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-combobox/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-combobox/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-combobox/multiple": {
"type": "boolean\n",
"description": "Changes select to multiple. Accepts array for value."
},
"v-combobox/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-combobox/items": {
"type": "any[]\n",
"description": "Can be an array of objects or strings. By default objects should have **title** and **value** properties, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props). Keys to use for these can be changed with the **item-title**, **item-value**, and **item-props** props."
},
"v-combobox/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-combobox/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-combobox/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-combobox/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-combobox/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-combobox/auto-select-first": {
"type": "boolean | 'exact'\n",
"description": "When searching, will always highlight the first option and select it on blur. `exact` will only highlight and select exact matches."
},
"v-combobox/filter-mode": {
"type": "'every' | 'some' | 'union' | 'intersection'\n",
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
},
"v-combobox/no-filter": {
"type": "boolean\n",
"description": "Disables all item filtering."
},
"v-combobox/custom-filter": {
"type": "FilterFunction\n",
"description": "Function used to filter items, called for each filterable key on each item in the list. The first argument is the filterable value from the item, the second is the search term, and the third is the internal item object. The function should return true if the item should be included in the filtered list, or the index of the match in the value if it should be included with the result highlighted."
},
"v-combobox/custom-key-filter": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
},
"v-combobox/filter-keys": {
"type": "string | string[]\n",
"description": "Array of specific keys to filter on the item."
},
"v-combobox/chips": {
"type": "boolean\n",
"description": "Changes display of selections to chips."
},
"v-combobox/closable-chips": {
"type": "boolean\n",
"description": "Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components."
},
"v-combobox/close-text": {
"type": "string\n",
"description": "Text set to to the inputs `aria-label` and `title` when input menu is closed."
},
"v-combobox/open-text": {
"type": "string\n",
"description": "Text set to to the inputs **aria-label** and **title** when input menu is open."
},
"v-combobox/hide-no-data": {
"type": "boolean\n",
"description": "Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open."
},
"v-combobox/hide-selected": {
"type": "boolean\n",
"description": "Do not display in the select menu items that are already selected."
},
"v-combobox/menu": {
"type": "boolean\n",
"description": "Renders with the menu open by default."
},
"v-combobox/menu-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Sets the the spin icon."
},
"v-combobox/menu-props": {
"type": "unknown\n",
"description": "Pass props through to the `v-menu` component. Accepts an object with anything from [v-menu](/api/v-menu/#props) props, camelCase keys are recommended."
},
"v-combobox/no-data-text": {
"type": "string\n",
"description": "Text shown when no items are provided to the component."
},
"v-combobox/open-on-clear": {
"type": "boolean\n",
"description": "Open's the menu whenever the clear icon is clicked."
},
"v-combobox/item-color": {
"type": "string\n",
"description": "Sets color of selected items."
},
"v-combobox/item-title": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its title."
},
"v-combobox/item-value": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its value."
},
"v-combobox/item-children": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its children."
},
"v-combobox/item-props": {
"type": "SelectItemKey\n",
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
},
"v-combobox/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-combobox/autofocus": {
"type": "boolean\n",
"description": "Enables autofocus."
},
"v-combobox/counter": {
"type": "string | number | boolean\n",
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
},
"v-combobox/prefix": {
"type": "string\n",
"description": "Displays prefix text."
},
"v-combobox/placeholder": {
"type": "string\n",
"description": "Sets the input’s placeholder text."
},
"v-combobox/persistent-placeholder": {
"type": "boolean\n",
"description": "Forces placeholder to always be visible."
},
"v-combobox/persistent-counter": {
"type": "boolean\n",
"description": "Forces counter to always be visible."
},
"v-combobox/suffix": {
"type": "string\n",
"description": "Displays suffix text."
},
"v-combobox/role": {
"type": "string\n",
"description": "The role attribute applied to the input."
},
"v-combobox/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-combobox/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-combobox/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-combobox/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-combobox/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-combobox/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-combobox/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-combobox/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-combobox/validate-on": {
"type": " | 'lazy'\n | 'input'\n | 'blur'\n | 'submit'\n | 'input lazy'\n | 'blur lazy'\n | 'submit lazy'\n | 'lazy input'\n | 'lazy blur'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-combobox/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-combobox/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-combobox/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared."
},
"v-combobox/clear-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when the **clearable** prop is set to true."
},
"v-combobox/persistent-clear": {
"type": "boolean\n",
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
},
"v-combobox/prepend-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
},
"v-combobox/single-line": {
"type": "boolean\n",
"description": "Label does not move on focus/dirty."
},
"v-combobox/counter-value": {
"type": "number | ((value: any) => number)\n",
"description": "Function returns the counter display text."
},
"v-combobox/model-modifiers": {
"type": "unknown\n",
"description": "**FOR INTERNAL USE ONLY**"
},
"v-combobox/delimiters": {
"type": "string[]\n",
"description": "Accepts an array of strings that will trigger a new tag when typing. Does not replace the normal Tab and Enter keys."
},
"v-component-icon/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-component-icon/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-confirm-edit/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-confirm-edit/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-confirm-edit/cancel-text": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VConfirmEdit.json))"
},
"v-confirm-edit/ok-text": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VConfirmEdit.json))"
},
"v-container/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-container/fluid": {
"type": "boolean\n",
"description": "Removes viewport maximum-width size breakpoints."
},
"v-counter/value": {
"type": "string | number\n",
"description": "Sets the current counter value."
},
"v-counter/transition": {
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-counter/active": {
"type": "boolean\n",
"description": "Determines whether the counter is visible or not."
},
"v-counter/max": {
"type": "string | number\n",
"description": "Sets the maximum allowed value."
},
"v-data-iterator/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-data-iterator/search": {
"type": "string\n",
"description": "Text input used to filter items."
},
"v-data-iterator/items": {
"type": "any[]\n",
"description": "An array of strings or objects used for automatically generating children components."
},
"v-data-iterator/filter-mode": {
"type": "'every' | 'some' | 'union' | 'intersection'\n",
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
},
"v-data-iterator/no-filter": {
"type": "boolean\n",
"description": "Disables all item filtering."
},
"v-data-iterator/custom-filter": {
"type": "FilterFunction\n",
"description": "Function to filter items."
},
"v-data-iterator/custom-key-filter": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
},
"v-data-iterator/filter-keys": {
"type": "string | string[]\n",
"description": "Array of specific keys to filter on the item."
},
"v-data-iterator/model-value": {
"type": "any[]\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-data-iterator/item-value": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its value."
},
"v-data-iterator/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-data-iterator/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-data-iterator/loading": {
"type": "boolean\n",
"description": "If `true` and no items are provided, then a loading text will be shown."
},
"v-data-iterator/item-selectable": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains the boolean value indicating if the item is selectable."
},
"v-data-iterator/show-select": {
"type": "boolean\n",
"description": "Shows the column with checkboxes for selecting items in the list."
},
"v-data-iterator/select-strategy": {
"type": "'single' | 'page' | 'all'\n",
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
},
"v-data-iterator/page": {
"type": "string | number\n",
"description": "The current displayed page number (1-indexed)."
},
"v-data-iterator/sort-by": {
"type": "SortItem[]\n",
"description": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier."
},
"v-data-iterator/multi-sort": {
"type": "boolean\n",
"description": "If `true` then one can sort on multiple properties."
},
"v-data-iterator/must-sort": {
"type": "boolean\n",
"description": "If `true` then one can not disable sorting, it will always switch between ascending and descending."
},
"v-data-iterator/custom-key-sort": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
},
"v-data-iterator/items-per-page": {
"type": "string | number\n",
"description": "Changes how many items per page should be visible. Can be used with `.sync` modifier. Setting this prop to `-1` will display all items on the page."
},
"v-data-iterator/expand-on-click": {
"type": "boolean\n",
"description": "Expands item when the row is clicked."
},
"v-data-iterator/show-expand": {
"type": "boolean\n",
"description": "Shows the expand icon."
},
"v-data-iterator/expanded": {
"type": "string[]\n",
"description": "Array of expanded items. Can be used with `.sync` modifier."
},
"v-data-iterator/group-by": {
"type": "SortItem[]\n",
"description": "Changes which item property should be used for grouping items. Currently only supports a single grouping in the format: `group` or `['group']`. When using an array, only the first element is considered. Can be used with `.sync` modifier."
},
"v-data-table/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-data-table/search": {
"type": "string\n",
"description": "Text input used to filter items."
},
"v-data-table/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-data-table/items": {
"type": "any[]\n",
"description": "An array of strings or objects used for automatically generating children components."
},
"v-data-table/filter-mode": {
"type": "'every' | 'some' | 'union' | 'intersection'\n",
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
},
"v-data-table/no-filter": {
"type": "boolean\n",
"description": "Disables all item filtering."
},
"v-data-table/custom-filter": {
"type": "FilterFunction\n",
"description": "Function to filter items."
},
"v-data-table/custom-key-filter": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
},
"v-data-table/filter-keys": {
"type": "string | string[]\n",
"description": "Array of specific keys to filter on the item."
},
"v-data-table/hide-no-data": {
"type": "boolean\n",
"description": "Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open."
},
"v-data-table/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-data-table/height": {
"type": "string | number\n",
"description": "Set an explicit height of table."
},
"v-data-table/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-data-table/no-data-text": {
"type": "string\n",
"description": "Text shown when no items are provided to the component."
},
"v-data-table/item-value": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its value."
},
"v-data-table/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-data-table/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-data-table/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height of the table rows."
},
"v-data-table/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-data-table/loading": {
"type": "string | boolean\n",
"description": "Displays `loading` slot if set to `true`"
},
"v-data-table/sticky": {
"type": "boolean\n",
"description": "Sticks the header to the top of the table."
},
"v-data-table/item-selectable": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that indicates whether the item is selectable."
},
"v-data-table/show-select": {
"type": "boolean\n",
"description": "Shows the select checkboxes in both the header and rows (if using default rows)."
},
"v-data-table/select-strategy": {
"type": "'single' | 'page' | 'all'\n",
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
},
"v-data-table/page": {
"type": "string | number\n",
"description": "The current displayed page number (1-indexed)."
},
"v-data-table/sort-by": {
"type": "SortItem[]\n",
"description": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier."
},
"v-data-table/multi-sort": {
"type": "boolean\n",
"description": "If `true` then one can sort on multiple properties."
},
"v-data-table/must-sort": {
"type": "boolean\n",
"description": "If `true` then one can not disable sorting, it will always switch between ascending and descending."
},
"v-data-table/custom-key-sort": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
},
"v-data-table/items-per-page": {
"type": "string | number\n",
"description": "Changes how many items per page should be visible. Can be used with `.sync` modifier. Setting this prop to `-1` will display all items on the page."
},
"v-data-table/expand-on-click": {
"type": "boolean\n",
"description": "Expands item when the row is clicked."
},
"v-data-table/show-expand": {
"type": "boolean\n",
"description": "Shows the expand toggle in default rows."
},
"v-data-table/expanded": {
"type": "string[]\n",
"description": "Whether the item is expanded or not."
},
"v-data-table/group-by": {
"type": "SortItem[]\n",
"description": "Changes which item property should be used for grouping items. Currently only supports a single grouping in the format: `group` or `['group']`. When using an array, only the first element is considered. Can be used with `.sync` modifier."
},
"v-data-table/cell-props": {
"type": " | Record\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/DataTable-items.json))"
},
"v-data-table/headers": {
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-group'\n | 'data-table-select'\n | 'data-table-expand'\n | undefined\n readonly value?: SelectItemKey\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'start' | 'end' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'index' | 'internalItem'\n >,\n ) => Record)\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction | undefined\n readonly filter?: FilterFunction | undefined\n readonly children?: readonly any[] | undefined\n}[]\n",
"description": "An array of objects that each describe a header column. See the example below for a definition of all properties."
},
"v-data-table/loading-text": {
"type": "string\n",
"description": "Text shown when the data is loading."
},
"v-data-table/row-height": {
"type": "number\n",
"description": "Height of each row in pixels."
},
"v-data-table/row-props": {
"type": " | Record\n | ((\n data: Pick, 'item' | 'index' | 'internalItem'>,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/DataTable-items.json))"
},
"v-data-table/sort-asc-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for ascending sort button."
},
"v-data-table/sort-desc-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for descending sort button."
},
"v-data-table/fixed-header": {
"type": "boolean\n",
"description": "Fixed header to top of table."
},
"v-data-table/fixed-footer": {
"type": "boolean\n",
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
},
"v-data-table/hover": {
"type": "boolean\n",
"description": "Adds a hover effects to a table rows."
},
"v-data-table/prev-icon": {
"type": "string\n",
"description": "Previous icon."
},
"v-data-table/next-icon": {
"type": "string\n",
"description": "Next icon."
},
"v-data-table/first-icon": {
"type": "string\n",
"description": "First icon."
},
"v-data-table/last-icon": {
"type": "string\n",
"description": "Last icon."
},
"v-data-table/items-per-page-text": {
"type": "string\n",
"description": "Text for items-per-page dropdown."
},
"v-data-table/page-text": {
"type": "string\n",
"description": "Label for page number."
},
"v-data-table/first-page-label": {
"type": "string\n",
"description": "Label for first page."
},
"v-data-table/prev-page-label": {
"type": "string\n",
"description": "Label for previous page."
},
"v-data-table/next-page-label": {
"type": "string\n",
"description": "Label for next page."
},
"v-data-table/last-page-label": {
"type": "string\n",
"description": "Label for last page."
},
"v-data-table/items-per-page-options": {
"type": "(number | { title: string; value: number })[]\n",
"description": "Array of options to show in the items-per-page dropdown."
},
"v-data-table/show-current-page": {
"type": "boolean\n",
"description": "Show current page number between prev/next icons."
},
"v-data-table-row/item": {
"type": "unknown\n",
"description": "Data (key, index and column values) of the displayed item."
},
"v-data-table-row/cell-props": {
"type": " | Record\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDataTableRow.json))"
},
"v-data-table-row/index": {
"type": "number\n",
"description": "Row index."
},
"v-data-table-rows/loading": {
"type": "string | boolean\n",
"description": "Displays `loading` slot if set to `true`"
},
"v-data-table-rows/items": {
"type": "(DataTableItem | Group)[]\n",
"description": "An array of strings or objects used for automatically generating children components."
},
"v-data-table-rows/hide-no-data": {
"type": "boolean\n",
"description": "Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open."
},
"v-data-table-rows/no-data-text": {
"type": "string\n",
"description": "Text shown when no items are provided to the component."
},
"v-data-table-rows/cell-props": {
"type": " | Record\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDataTableRows.json))"
},
"v-data-table-rows/loading-text": {
"type": "string\n",
"description": "Text shown when the data is loading."
},
"v-data-table-rows/row-height": {
"type": "number\n",
"description": "Height of each row in pixels."
},
"v-data-table-rows/row-props": {
"type": " | Record\n | ((\n data: Pick, 'item' | 'index' | 'internalItem'>,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDataTableRows.json))"
},
"v-data-table-server/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-data-table-server/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-data-table-server/height": {
"type": "string | number\n",
"description": "Use the height prop to set the height of the table."
},
"v-data-table-server/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-data-table-server/sticky": {
"type": "boolean\n",
"description": "Sticks the header to the top of the table."
},
"v-data-table-server/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-data-table-server/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-data-table-server/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-data-table-server/search": {
"type": "string\n",
"description": "Text input used to filter items."
},
"v-data-table-server/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-data-table-server/items": {
"type": "any[]\n",
"description": "An array of strings or objects used for automatically generating children components."
},
"v-data-table-server/hover": {
"type": "boolean\n",
"description": "Will add a hover effect to a table's row when the mouse is over it."
},
"v-data-table-server/next-icon": {
"type": "string\n",
"description": "Next icon."
},
"v-data-table-server/prev-icon": {
"type": "string\n",
"description": "Previous icon."
},
"v-data-table-server/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-data-table-server/hide-no-data": {
"type": "boolean\n",
"description": "Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open."
},
"v-data-table-server/no-data-text": {
"type": "string\n",
"description": "Text shown when no items are provided to the component."
},
"v-data-table-server/item-value": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its value."
},
"v-data-table-server/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-data-table-server/cell-props": {
"type": " | Record\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/DataTable-items.json))"
},
"v-data-table-server/expanded": {
"type": "string[]\n",
"description": "Whether the item is expanded or not."
},
"v-data-table-server/expand-on-click": {
"type": "boolean\n",
"description": "Expands item when the row is clicked."
},
"v-data-table-server/select-strategy": {
"type": "'single' | 'page' | 'all'\n",
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
},
"v-data-table-server/page": {
"type": "string | number\n",
"description": "The current displayed page number (1-indexed)."
},
"v-data-table-server/loading-text": {
"type": "string\n",
"description": "Text shown when the data is loading."
},
"v-data-table-server/row-height": {
"type": "number\n",
"description": "Height of each row in pixels."
},
"v-data-table-server/row-props": {
"type": " | Record\n | ((\n data: Pick, 'item' | 'index' | 'internalItem'>,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/DataTable-items.json))"
},
"v-data-table-server/group-by": {
"type": "SortItem[]\n",
"description": "Defines the grouping of the table items."
},
"v-data-table-server/sort-by": {
"type": "SortItem[]\n",
"description": "Array of column keys and sort orders that determines the sort order of the table."
},
"v-data-table-server/headers": {
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-expand'\n | 'data-table-select'\n | 'data-table-group'\n | undefined\n readonly value?: SelectItemKey\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'end' | 'start' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'index' | 'internalItem'\n >,\n ) => Record)\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction | undefined\n readonly filter?: FilterFunction | undefined\n readonly children?: readonly any[] | undefined\n}[]\n",
"description": "An array of objects that each describe a header column."
},
"v-data-table-server/items-length": {
"type": "string | number\n",
"description": "Number of all items."
},
"v-data-table-server/items-per-page": {
"type": "string | number\n",
"description": "The number of items to display on each page."
},
"v-data-table-server/show-expand": {
"type": "boolean\n",
"description": "Shows the expand icon."
},
"v-data-table-server/item-selectable": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that indicates whether the item is selectable."
},
"v-data-table-server/show-select": {
"type": "boolean\n",
"description": "Shows the column with checkboxes for selecting items in the list."
},
"v-data-table-server/multi-sort": {
"type": "boolean\n",
"description": "Allows sorting by multiple columns."
},
"v-data-table-server/must-sort": {
"type": "boolean\n",
"description": "Forces sorting on the column(s)."
},
"v-data-table-server/custom-key-sort": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
},
"v-data-table-server/sort-asc-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for ascending sort button."
},
"v-data-table-server/sort-desc-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for descending sort button."
},
"v-data-table-server/fixed-header": {
"type": "boolean\n",
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
},
"v-data-table-server/fixed-footer": {
"type": "boolean\n",
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
},
"v-data-table-server/first-icon": {
"type": "string\n",
"description": "First icon."
},
"v-data-table-server/last-icon": {
"type": "string\n",
"description": "Last icon."
},
"v-data-table-server/items-per-page-text": {
"type": "string\n",
"description": "Text for items-per-page dropdown."
},
"v-data-table-server/page-text": {
"type": "string\n",
"description": "Label for page number."
},
"v-data-table-server/first-page-label": {
"type": "string\n",
"description": "Label for first page."
},
"v-data-table-server/prev-page-label": {
"type": "string\n",
"description": "Label for previous page."
},
"v-data-table-server/next-page-label": {
"type": "string\n",
"description": "Label for next page."
},
"v-data-table-server/last-page-label": {
"type": "string\n",
"description": "Label for last page."
},
"v-data-table-server/items-per-page-options": {
"type": "(number | { title: string; value: number })[]\n",
"description": "Array of options to show in the items-per-page dropdown."
},
"v-data-table-server/show-current-page": {
"type": "boolean\n",
"description": "Show current page number between prev/next icons."
},
"v-data-table-virtual/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-data-table-virtual/search": {
"type": "string\n",
"description": "Text input used to filter items."
},
"v-data-table-virtual/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-data-table-virtual/items": {
"type": "any[]\n",
"description": "An array of strings or objects used for automatically generating children components."
},
"v-data-table-virtual/filter-mode": {
"type": "'every' | 'some' | 'union' | 'intersection'\n",
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
},
"v-data-table-virtual/no-filter": {
"type": "boolean\n",
"description": "Disables all item filtering."
},
"v-data-table-virtual/custom-filter": {
"type": "FilterFunction\n",
"description": "Function used to filter items, called for each filterable key on each item in the list. The first argument is the filterable value from the item, the second is the search term, and the third is the internal item object. The function should return true if the item should be included in the filtered list, or the index of the match in the value if it should be included with the result highlighted."
},
"v-data-table-virtual/custom-key-filter": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
},
"v-data-table-virtual/filter-keys": {
"type": "string | string[]\n",
"description": "Array of specific keys to filter on the item."
},
"v-data-table-virtual/hide-no-data": {
"type": "boolean\n",
"description": "Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open."
},
"v-data-table-virtual/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-data-table-virtual/height": {
"type": "string | number\n",
"description": "Use the height prop to set the height of the table."
},
"v-data-table-virtual/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-data-table-virtual/no-data-text": {
"type": "string\n",
"description": "Text shown when no items are provided to the component."
},
"v-data-table-virtual/item-value": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its value."
},
"v-data-table-virtual/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-data-table-virtual/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-data-table-virtual/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-data-table-virtual/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-data-table-virtual/loading": {
"type": "string | boolean\n",
"description": "Displays `loading` slot if set to `true`"
},
"v-data-table-virtual/sticky": {
"type": "boolean\n",
"description": "Sticks the header to the top of the table."
},
"v-data-table-virtual/item-selectable": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that indicates whether the item is selectable."
},
"v-data-table-virtual/show-select": {
"type": "boolean\n",
"description": "Shows the column with checkboxes for selecting items in the list."
},
"v-data-table-virtual/select-strategy": {
"type": "'single' | 'page' | 'all'\n",
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
},
"v-data-table-virtual/sort-by": {
"type": "SortItem[]\n",
"description": "Array of column keys and sort orders that determines the sort order of the table."
},
"v-data-table-virtual/multi-sort": {
"type": "boolean\n",
"description": "Allows sorting by multiple columns."
},
"v-data-table-virtual/must-sort": {
"type": "boolean\n",
"description": "Forces sorting on the column(s)."
},
"v-data-table-virtual/custom-key-sort": {
"type": "unknown\n",
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
},
"v-data-table-virtual/expand-on-click": {
"type": "boolean\n",
"description": "Expands item when the row is clicked."
},
"v-data-table-virtual/show-expand": {
"type": "boolean\n",
"description": "Shows the expand icon."
},
"v-data-table-virtual/expanded": {
"type": "string[]\n",
"description": "Whether the item is expanded or not."
},
"v-data-table-virtual/group-by": {
"type": "SortItem[]\n",
"description": "Defines the grouping of the table items."
},
"v-data-table-virtual/cell-props": {
"type": " | Record\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/DataTable-items.json))"
},
"v-data-table-virtual/headers": {
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-group'\n | 'data-table-select'\n | 'data-table-expand'\n | undefined\n readonly value?: SelectItemKey\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'start' | 'end' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot,\n 'value' | 'item' | 'index' | 'internalItem'\n >,\n ) => Record)\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction | undefined\n readonly filter?: FilterFunction | undefined\n readonly children?: readonly any[] | undefined\n}[]\n",
"description": "An array of objects that each describe a header column."
},
"v-data-table-virtual/loading-text": {
"type": "string\n",
"description": "Text shown when the data is loading."
},
"v-data-table-virtual/row-height": {
"type": "number\n",
"description": "Height of each row in pixels."
},
"v-data-table-virtual/row-props": {
"type": " | Record\n | ((\n data: Pick, 'item' | 'index' | 'internalItem'>,\n ) => Record)\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/DataTable-items.json))"
},
"v-data-table-virtual/sort-asc-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for ascending sort button."
},
"v-data-table-virtual/sort-desc-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for descending sort button."
},
"v-data-table-virtual/fixed-header": {
"type": "boolean\n",
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
},
"v-data-table-virtual/fixed-footer": {
"type": "boolean\n",
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
},
"v-data-table-virtual/hover": {
"type": "boolean\n",
"description": "Will add a hover effect to a table's row when the mouse is over it."
},
"v-data-table-virtual/item-height": {
"type": "string | number\n",
"description": "Height in pixels of each item to display."
},
"v-date-picker/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-date-picker/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-date-picker/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-date-picker/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-date-picker/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-date-picker/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-date-picker/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-date-picker/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-date-picker/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-date-picker/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-date-picker/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-date-picker/width": {
"type": "string | number\n",
"description": "Width of the picker."
},
"v-date-picker/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-date-picker/multiple": {
"type": "boolean\n",
"description": "Allow the selection of multiple dates."
},
"v-date-picker/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-date-picker/active": {
"type": "string | string[]\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-date-picker/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-date-picker/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-date-picker/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-date-picker/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-date-picker/max": {
"type": "unknown\n",
"description": "Maximum allowed date/month (ISO 8601 format)."
},
"v-date-picker/position": {
"type": "'fixed' | 'relative' | 'absolute' | 'static' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-date-picker/header": {
"type": "string\n",
"description": "Text shown when no **display-date** is set."
},
"v-date-picker/prev-icon": {
"type": "string\n",
"description": "Sets the icon for previous month/year button."
},
"v-date-picker/next-icon": {
"type": "string\n",
"description": "Sets the icon for next month/year button."
},
"v-date-picker/calendar-icon": {
"type": "string\n",
"description": "The icon shown in the header when in 'input' **input-mode**."
},
"v-date-picker/keyboard-icon": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePicker.json))"
},
"v-date-picker/input-mode": {
"type": "'calendar' | 'keyboard'\n",
"description": "Toggles between showing dates or inputs."
},
"v-date-picker/input-text": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePicker.json))"
},
"v-date-picker/input-placeholder": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePicker.json))"
},
"v-date-picker/mode-icon": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerControls.json))"
},
"v-date-picker/view-mode": {
"type": "'month' | 'months' | 'year'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerControls.json))"
},
"v-date-picker/month": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker/year": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker/allowed-dates": {
"type": "Function | unknown[]\n",
"description": "Restricts which dates can be selected."
},
"v-date-picker/hide-weekdays": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker/show-adjacent-months": {
"type": "boolean\n",
"description": "Toggles visibility of days from previous and next months."
},
"v-date-picker/show-week": {
"type": "boolean\n",
"description": "Toggles visibility of the week numbers in the body of the calendar."
},
"v-date-picker/min": {
"type": "unknown\n",
"description": "Minimum allowed date/month (ISO 8601 format)."
},
"v-date-picker/landscape": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VPicker.json))"
},
"v-date-picker/hide-header": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VPicker.json))"
},
"v-date-picker-controls/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-date-picker-controls/active": {
"type": "string | string[]\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-date-picker-controls/disabled": {
"type": "string | boolean | string[]\n",
"description": "Removes the ability to click or target the component."
},
"v-date-picker-controls/next-icon": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerControls.json))"
},
"v-date-picker-controls/prev-icon": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerControls.json))"
},
"v-date-picker-controls/mode-icon": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerControls.json))"
},
"v-date-picker-controls/view-mode": {
"type": "'month' | 'months' | 'year'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerControls.json))"
},
"v-date-picker-header/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-date-picker-header/header": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerHeader.json))"
},
"v-date-picker-header/append-icon": {
"type": "string\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-date-picker-header/transition": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerHeader.json))"
},
"v-date-picker-month/model-value": {
"type": "unknown[]\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-date-picker-month/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-date-picker-month/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-date-picker-month/max": {
"type": "unknown\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/multiple": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/month": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/year": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/allowed-dates": {
"type": "Function | unknown[]\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/hide-weekdays": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/show-adjacent-months": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/show-week": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-month/min": {
"type": "unknown\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerMonth.json))"
},
"v-date-picker-months/model-value": {
"type": "number\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-date-picker-months/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-date-picker-months/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-date-picker-years/model-value": {
"type": "number\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-date-picker-years/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-date-picker-years/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-date-picker-years/max": {
"type": "unknown\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerYears.json))"
},
"v-date-picker-years/min": {
"type": "unknown\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VDatePickerYears.json))"
},
"v-defaults-provider/disabled": {
"type": "boolean\n",
"description": "Turns off all calculations of new default values for improved performance in situations where defaults propagation isn't necessary."
},
"v-defaults-provider/root": {
"type": "string | boolean\n",
"description": "Force current defaults to match the application root defaults."
},
"v-defaults-provider/reset": {
"type": "string | number\n",
"description": "Reset the default values up the nested chain by {n} amount."
},
"v-defaults-provider/scoped": {
"type": "boolean\n",
"description": "Prevents the ability for default values to be inherited from parent components."
},
"v-defaults-provider/defaults": {
"type": "{\n global: Record\n [string]: Record\n}\n",
"description": "Specify new default prop values for components. Keep in mind that this will be merged with previously defined values."
},
"v-dialog/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-dialog/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-dialog/activator": {
"type": "(string & {}) | Element | 'parent' | ComponentPublicInstance\n",
"description": "Explicitly sets the overlay's activator."
},
"v-dialog/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the content element."
},
"v-dialog/close-on-back": {
"type": "boolean\n",
"description": "Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing."
},
"v-dialog/contained": {
"type": "boolean\n",
"description": "Limits the size of the component and scrim to its offset parent. Implies `absolute` and `attach`. (Note: The parent element must have position: relative.)."
},
"v-dialog/content-class": {
"type": "any\n",
"description": "Applies a custom class to the detached element. This is useful because the content is moved to the beginning of the `v-app` component (unless the **attach** prop is provided) and is not targetable by classes passed directly on the component."
},
"v-dialog/content-props": {
"type": "any\n",
"description": "Apply custom properties to the content."
},
"v-dialog/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-dialog/no-click-animation": {
"type": "boolean\n",
"description": "Disables the bounce effect when clicking outside of a `v-dialog`'s content when using the **persistent** prop."
},
"v-dialog/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-dialog/persistent": {
"type": "boolean\n",
"description": "Clicking outside of the element or pressing **esc** key will not deactivate it."
},
"v-dialog/scrim": {
"type": "string | boolean\n",
"description": "Accepts true/false to enable background, and string to define color."
},
"v-dialog/z-index": {
"type": "string | number\n",
"description": "The z-index used for the component."
},
"v-dialog/target": {
"type": " | (string & {})\n | Element\n | 'parent'\n | 'cursor'\n | ComponentPublicInstance\n | [number, number]\n",
"description": "For locationStrategy=\"connected\", specify an element or array of x,y coordinates that the overlay should position itself relative to. This will be the activator element by default."
},
"v-dialog/activator-props": {
"type": "unknown\n",
"description": "Apply custom properties to the activator."
},
"v-dialog/open-on-click": {
"type": "boolean\n",
"description": "Activate the component when the activator is clicked."
},
"v-dialog/open-on-hover": {
"type": "boolean\n",
"description": "Designates whether component should activate when its activator is hovered."
},
"v-dialog/open-on-focus": {
"type": "boolean\n",
"description": "Activate the component when the activator is focused."
},
"v-dialog/close-on-content-click": {
"type": "boolean\n",
"description": "Closes component when you click on its content."
},
"v-dialog/close-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before closing component. Only applies to hover and focus events."
},
"v-dialog/open-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before opening component. Only applies to hover and focus events."
},
"v-dialog/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-dialog/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-dialog/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-dialog/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-dialog/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-dialog/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-dialog/location-strategy": {
"type": "'static' | 'connected' | LocationStrategyFn\n",
"description": "A function used to specifies how the component should position relative to its activator."
},
"v-dialog/location": {
"type": "Anchor\n",
"description": "Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both.."
},
"v-dialog/origin": {
"type": "Anchor | 'auto' | 'overlap'\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-dialog/offset": {
"type": "string | number | number[]\n",
"description": "A single value that offsets content away from the target based upon what side it is on."
},
"v-dialog/scroll-strategy": {
"type": "'none' | 'close' | 'block' | 'reposition' | ScrollStrategyFn\n",
"description": "Strategy used when the component is activate and user scrolls."
},
"v-dialog/transition": {
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-dialog/attach": {
"type": "string | boolean | Element\n",
"description": "Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default."
},
"v-dialog/fullscreen": {
"type": "boolean\n",
"description": "Changes layout for fullscreen display."
},
"v-dialog/retain-focus": {
"type": "boolean\n",
"description": "Tab focus will return to the first child of the dialog by default. Disable this when using external tools that require focus such as TinyMCE or vue-clipboard."
},
"v-dialog/scrollable": {
"type": "boolean\n",
"description": "When set to true, expects a `v-card` and a `v-card-text` component with a designated height. For more information, check out the [scrollable example](/components/dialogs#scrollable)."
},
"v-dialog-bottom-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-dialog-bottom-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-dialog-bottom-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-dialog-bottom-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-dialog-bottom-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-dialog-bottom-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-dialog-top-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-dialog-top-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-dialog-top-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-dialog-top-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-dialog-top-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-dialog-top-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-dialog-transition/target": {
"type": "HTMLElement | [number, number]\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/v-dialog-transition.json))"
},
"v-divider/length": {
"type": "string | number\n",
"description": "Sets the dividers length. Default unit is px."
},
"v-divider/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-divider/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-divider/inset": {
"type": "boolean\n",
"description": "Adds indentation (72px) for **normal** dividers, reduces max height for **vertical**."
},
"v-divider/vertical": {
"type": "boolean\n",
"description": "Displays dividers vertically."
},
"v-divider/thickness": {
"type": "string | number\n",
"description": "Sets the dividers thickness. Default unit is px."
},
"v-expand-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-expand-transition/mode": {
"type": "'default' | 'in-out' | 'out-in'\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-expand-x-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-expand-x-transition/mode": {
"type": "'default' | 'in-out' | 'out-in'\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-expansion-panel/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-expansion-panel/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-expansion-panel/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-expansion-panel/static": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VExpansionPanelTitle.json))"
},
"v-expansion-panel/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-expansion-panel/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-expansion-panel/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-expansion-panel/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-expansion-panel/value": {
"type": "any\n",
"description": "Controls the opened/closed state of content."
},
"v-expansion-panel/disabled": {
"type": "boolean\n",
"description": "Disables the expansion-panel content."
},
"v-expansion-panel/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-expansion-panel/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-expansion-panel/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-expansion-panel/readonly": {
"type": "boolean\n",
"description": "Makes the expansion-panel content read only."
},
"v-expansion-panel/expand-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used when the expansion panel is in a expandable state."
},
"v-expansion-panel/collapse-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used when the expansion panel is in a collapsable state."
},
"v-expansion-panel/hide-actions": {
"type": "boolean\n",
"description": "Hide the expand icon in the content title."
},
"v-expansion-panel-text/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-expansion-panel-title/static": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VExpansionPanelTitle.json))"
},
"v-expansion-panel-title/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-expansion-panel-title/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-expansion-panel-title/readonly": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VExpansionPanelTitle.json))"
},
"v-expansion-panel-title/expand-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used when the expansion panel is in a expandable state."
},
"v-expansion-panel-title/collapse-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used when the expansion panel is in a collapsable state."
},
"v-expansion-panel-title/hide-actions": {
"type": "boolean\n",
"description": "Hide the expand icon in the content title."
},
"v-expansion-panels/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-expansion-panels/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-expansion-panels/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-expansion-panels/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-expansion-panels/static": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VExpansionPanels.json))"
},
"v-expansion-panels/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-expansion-panels/readonly": {
"type": "boolean\n",
"description": "Makes the entire expansion-panel read only."
},
"v-expansion-panels/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-expansion-panels/variant": {
"type": "'default' | 'accordion' | 'inset' | 'popout'\n",
"description": "Applies a distinct style to the component."
},
"v-expansion-panels/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-expansion-panels/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-expansion-panels/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-fab-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-fab-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-fab-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-fab-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-fab-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-fab-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-fade-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-fade-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-fade-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-fade-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-fade-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-fade-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-field/flat": {
"type": "boolean\n",
"description": "Removes box shadow when using a variant with elevation."
},
"v-field/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-field/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-field/reverse": {
"type": "boolean\n",
"description": "Reverses the orientation."
},
"v-field/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-field/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-field/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-field/variant": {
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
"description": "Applies a distinct style to the component."
},
"v-field/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-field/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-field/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-field/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-field/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-field/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-field/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-field/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-field/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-field/append-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot."
},
"v-field/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared."
},
"v-field/clear-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when the **clearable** prop is set to true."
},
"v-field/dirty": {
"type": "boolean\n",
"description": "Manually apply the dirty state styling."
},
"v-field/persistent-clear": {
"type": "boolean\n",
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
},
"v-field/prepend-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
},
"v-field/single-line": {
"type": "boolean\n",
"description": "Label does not move on focus/dirty."
},
"v-field-label/floating": {
"type": "boolean\n",
"description": "Elevates the label above the slotted content."
},
"v-file-input/flat": {
"type": "boolean\n",
"description": "Removes box shadow when using a variant with elevation."
},
"v-file-input/reverse": {
"type": "boolean\n",
"description": "Reverses the orientation."
},
"v-file-input/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-file-input/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-file-input/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-file-input/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-file-input/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-file-input/chips": {
"type": "boolean\n",
"description": "Changes display of selections to chips."
},
"v-file-input/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-file-input/model-value": {
"type": "File[]\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-file-input/multiple": {
"type": "boolean\n",
"description": "Adds the **multiple** attribute to the input, allowing multiple file selections."
},
"v-file-input/counter": {
"type": "boolean\n",
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
},
"v-file-input/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-file-input/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-file-input/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-file-input/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-file-input/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-file-input/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-file-input/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-file-input/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-file-input/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-file-input/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-file-input/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-file-input/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-file-input/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-file-input/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-file-input/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-file-input/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-file-input/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-file-input/append-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot."
},
"v-file-input/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-file-input/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared."
},
"v-file-input/clear-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when the **clearable** prop is set to true."
},
"v-file-input/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-file-input/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-file-input/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-file-input/dirty": {
"type": "boolean\n",
"description": "Manually apply the dirty state styling."
},
"v-file-input/persistent-clear": {
"type": "boolean\n",
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
},
"v-file-input/prepend-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
},
"v-file-input/single-line": {
"type": "boolean\n",
"description": "Label does not move on focus/dirty."
},
"v-file-input/variant": {
"type": " | 'underlined'\n | 'outlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-file-input/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-file-input/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-file-input/counter-size-string": {
"type": "string\n",
"description": "The text displayed when using the **counter** and **show-size** props. Can also be customized globally on the [internationalization page](/customization/internationalization)."
},
"v-file-input/counter-string": {
"type": "string\n",
"description": "The text displayed when using the **counter** prop. Can also be customized globally on the [internationalization page](/customization/internationalization)."
},
"v-file-input/show-size": {
"type": "boolean | 1000 | 1024\n",
"description": "Sets the displayed size of selected file(s). When using **true** will default to _1000_ displaying (**kB, MB, GB**) while _1024_ will display (**KiB, MiB, GiB**)."
},
"v-footer/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-footer/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-footer/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-footer/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the component."
},
"v-footer/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-footer/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-footer/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-footer/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-footer/name": {
"type": "string\n",
"description": "Assign a specific name for layout registration."
},
"v-footer/order": {
"type": "string | number\n",
"description": "Adjust the order of the component in relation to its registration order."
},
"v-footer/app": {
"type": "boolean\n",
"description": "Determines the position of the footer. If true, the footer would be given a fixed position at the bottom of the viewport. If false, the footer is set to the bottom of the page."
},
"v-form/model-value": {
"type": "boolean\n",
"description": "The value representing the validity of the form. If the value is `null` then no validation has taken place yet, or the form has been reset. Otherwise the value will be a `boolean` that indicates if validation has passed or not."
},
"v-form/disabled": {
"type": "boolean\n",
"description": "Puts all children inputs into a disabled state."
},
"v-form/readonly": {
"type": "boolean\n",
"description": "Puts all children inputs into a readonly state."
},
"v-form/validate-on": {
"type": " | 'lazy'\n | 'input'\n | 'blur'\n | 'submit'\n | 'input lazy'\n | 'blur lazy'\n | 'submit lazy'\n | 'lazy input'\n | 'lazy blur'\n | 'lazy submit'\n",
"description": "Changes the events in which validation occurs."
},
"v-form/fast-fail": {
"type": "boolean\n",
"description": "Stop validation as soon as any rules fail."
},
"v-hover/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-hover/disabled": {
"type": "boolean\n",
"description": "Removes hover functionality."
},
"v-hover/close-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before closing component. Only applies to hover and focus events."
},
"v-hover/open-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before opening component. Only applies to hover and focus events."
},
"v-icon/end": {
"type": "boolean\n",
"description": "Applies margin at the start of the component."
},
"v-icon/start": {
"type": "boolean\n",
"description": "Applies margin at the end of the component."
},
"v-icon/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-icon/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-icon/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-icon/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-icon/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-img/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-img/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-img/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-img/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-img/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-img/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-img/position": {
"type": "string\n",
"description": "Applies [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) styles to the image and placeholder elements."
},
"v-img/inline": {
"type": "boolean\n",
"description": "Display as an inline element instead of a block, also disables flex-grow."
},
"v-img/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "The transition to use when switching from `lazy-src` to `src`. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-img/content-class": {
"type": "string\n",
"description": "Apply a custom class to the internal content element."
},
"v-img/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-img/options": {
"type": "IntersectionObserverInit\n",
"description": "Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor."
},
"v-img/draggable": {
"type": "boolean | 'true' | 'false'\n",
"description": "Controls the `draggable` behavior of the image. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/draggable)."
},
"v-img/alt": {
"type": "string\n",
"description": "Alternate text for screen readers. Leave empty for decorative images."
},
"v-img/cover": {
"type": "boolean\n",
"description": "Resizes the background image to cover the entire container."
},
"v-img/gradient": {
"type": "string\n",
"description": "The gradient to apply to the image. This can be any valid CSS gradient declaration. You can find more information on the [MDN documentation for gradients](https://developer.mozilla.org/en-US/docs/Web/CSS/gradient)."
},
"v-img/lazy-src": {
"type": "string\n",
"description": "Something to show while waiting for the main image to load, typically a small base64-encoded thumbnail. Has a slight blur filter applied.\n\nUse [vuetify-loader](https://github.com/vuetifyjs/vuetify-loader) to generate automatically. NOTE: This prop has no effect unless either `height` or `aspect-ratio` are provided."
},
"v-img/sizes": {
"type": "string\n",
"description": "For use with `srcset`, see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)."
},
"v-img/src": {
"type": " | string\n | { src: string; srcset: string; lazySrc: string; aspect: number }\n",
"description": "The image URL. This prop is mandatory."
},
"v-img/srcset": {
"type": "string\n",
"description": "A set of alternate images to use based on device size. [Read more...](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset)."
},
"v-img/aspect-ratio": {
"type": "string | number\n",
"description": "Calculated as `width/height`, so for a 1920x1080px image this will be `1.7778`. Will be calculated automatically if omitted."
},
"v-img/crossorigin": {
"type": "'' | 'anonymous' | 'use-credentials'\n",
"description": "Specify that images should be fetched with CORS enabled [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#crossorigin)"
},
"v-img/referrerpolicy": {
"type": " | 'origin'\n | 'no-referrer'\n | 'no-referrer-when-downgrade'\n | 'origin-when-cross-origin'\n | 'same-origin'\n | 'strict-origin'\n | 'strict-origin-when-cross-origin'\n | 'unsafe-url'\n",
"description": "Define which referrer is sent when fetching the resource [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#referrerpolicy)"
},
"v-infinite-scroll/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-infinite-scroll/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-infinite-scroll/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-infinite-scroll/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-infinite-scroll/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-infinite-scroll/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-infinite-scroll/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-infinite-scroll/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Specifies if scroller is **vertical** or **horizontal**."
},
"v-infinite-scroll/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-infinite-scroll/mode": {
"type": "'intersect' | 'manual'\n",
"description": "Specifies if content should load automatically when scrolling (**intersect**) or manually (**manual**)."
},
"v-infinite-scroll/side": {
"type": "'start' | 'end' | 'both'\n",
"description": "Specifies the side where new content should appear. Either the **start**, **end**, or **both** sides."
},
"v-infinite-scroll/margin": {
"type": "string | number\n",
"description": "Value sent to the intersection observer. Will make the observer trigger earlier, by the margin (px) value supplied."
},
"v-infinite-scroll/load-more-text": {
"type": "string\n",
"description": "Text shown in default load more button, when in manual mode."
},
"v-infinite-scroll/empty-text": {
"type": "string\n",
"description": "Text shown when there is no more content to load."
},
"v-input/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-input/id": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VInput.json))"
},
"v-input/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-input/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-input/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-input/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-input/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-input/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-input/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-input/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-input/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-input/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-input/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-input/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-input/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-input/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-input/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-input/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-input/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-input/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-input/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-input/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-input/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-item/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-item/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-item/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-item-group/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-item-group/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-item-group/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-item-group/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-item-group/selected-class": {
"type": "string\n",
"description": "Configure the selected CSS class. This class will be available in `v-item` default scoped slot."
},
"v-item-group/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-item-group/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-item-group/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-kbd/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-label/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-label/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-label/clickable": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VLabel.json))"
},
"v-layout/full-height": {
"type": "boolean\n",
"description": "Sets the component height to 100%."
},
"v-layout/overlaps": {
"type": "string[]\n",
"description": "**FOR INTERNAL USE ONLY**"
},
"v-layout-item/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-layout-item/position": {
"type": "'top' | 'bottom' | 'left' | 'right'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VLayoutItem.json))"
},
"v-layout-item/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the component."
},
"v-layout-item/name": {
"type": "string\n",
"description": "Assign a specific name for layout registration."
},
"v-layout-item/order": {
"type": "string | number\n",
"description": "Adjust the order of the component in relation to its registration order."
},
"v-layout-item/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component."
},
"v-lazy/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-lazy/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-lazy/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-lazy/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-lazy/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-lazy/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-lazy/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-lazy/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-lazy/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-lazy/options": {
"type": "IntersectionObserverInit\n",
"description": "Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor."
},
"v-ligature-icon/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-ligature-icon/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-list/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-list/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-list/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-list/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-list/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-list/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-list/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-list/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-list/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-list/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-list/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-list/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-list/slim": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VList.json))"
},
"v-list/disabled": {
"type": "boolean\n",
"description": "Puts all children inputs into a disabled state."
},
"v-list/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-list/lines": {
"type": "false | 'one' | 'two' | 'three'\n",
"description": "Designates a **minimum-height** for all children `v-list-item` components. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers."
},
"v-list/mandatory": {
"type": "boolean\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-list/active-class": {
"type": "string\n",
"description": "The class applied to the component when it is in an active state."
},
"v-list/active-color": {
"type": "string\n",
"description": "The applied color when the component is in an active state."
},
"v-list/items": {
"type": "any[]\n",
"description": "Can be an array of objects or strings. By default objects should have a **title** property, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props), a **value** property to allow selection, and a **children** property containing more item objects. Keys to use for these can be changed with the **item-title**, **item-value**, **item-props**, and **item-children** props."
},
"v-list/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VList.json))"
},
"v-list/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-list/item-title": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its title."
},
"v-list/item-value": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its value."
},
"v-list/item-children": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its children."
},
"v-list/item-props": {
"type": "SelectItemKey\n",
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
},
"v-list/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-list/select-strategy": {
"type": " | 'single-leaf'\n | 'leaf'\n | 'independent'\n | 'single-independent'\n | 'classic'\n | SelectStrategyFn\n",
"description": "Affects how items with children behave when selected.\n- **leaf:** Only leaf nodes (items without children) can be selected.\n- **independent:** All nodes can be selected whether they have children or not.\n- **classic:** Selecting a parent node will cause all children to be selected, parent nodes will be displayed as selected if all their descendants are selected. Only leaf nodes will be added to the model."
},
"v-list/nav": {
"type": "boolean\n",
"description": "An alternative styling that reduces `v-list-item` width and rounds the corners. Typically used with **[v-navigation-drawer](/components/navigation-drawers)**."
},
"v-list/open-strategy": {
"type": " | 'multiple'\n | 'single'\n | 'list'\n | { open: OpenStrategyFn; select: OpenSelectStrategyFn }\n",
"description": "Affects how items with children behave when expanded.\n- **multiple:** Any number of groups can be open at once.\n- **single:** Only one group at each level can be open, opening a group will cause others to close.\n- **list:** Multiple, but all other groups will close when an item is selected."
},
"v-list/opened": {
"type": "unknown[]\n",
"description": "An array containing the values of currently opened groups. Can be two-way bound with `v-model:opened`."
},
"v-list/selected": {
"type": "unknown[]\n",
"description": "An array containing the values of currently selected items. Can be two-way bound with `v-model:selected`."
},
"v-list/item-type": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VList.json))"
},
"v-list-group/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-group/value": {
"type": "any\n",
"description": "Expands / Collapse the list-group."
},
"v-list-group/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-list-group/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-list-group/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-list-group/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-list-group/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListGroup.json))"
},
"v-list-group/active-color": {
"type": "string\n",
"description": "The applied color when the component is in an active state."
},
"v-list-group/fluid": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListGroup.json))"
},
"v-list-group/collapse-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListGroup.json))"
},
"v-list-group/expand-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListGroup.json))"
},
"v-list-group/subgroup": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListGroup.json))"
},
"v-list-img/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-item/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-item/replace": {
"type": "boolean\n",
"description": "Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [replace](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
},
"v-list-item/link": {
"type": "boolean\n",
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
},
"v-list-item/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-list-item/value": {
"type": "any\n",
"description": "The value used for selection."
},
"v-list-item/exact": {
"type": "boolean\n",
"description": "Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation."
},
"v-list-item/title": {
"type": "string | number | boolean\n",
"description": "Generates a `v-list-item-title` component with the supplied value. Note that this overrides the native [`title`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) attribute, that must be set with `v-bind:title.attr` instead."
},
"v-list-item/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-list-item/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-list-item/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-list-item/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-list-item/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-list-item/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-list-item/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-list-item/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-list-item/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
},
"v-list-item/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-list-item/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-list-item/color": {
"type": "string\n",
"description": "Applies specified color to the control when in an **active** state or **input-value** is **true** - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors),"
},
"v-list-item/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListItem.json))"
},
"v-list-item/variant": {
"type": "'flat' | 'text' | 'outlined' | 'plain' | 'elevated' | 'tonal'\n",
"description": "Applies a distinct style to the component."
},
"v-list-item/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-list-item/active-class": {
"type": "string\n",
"description": "The class applied to the component when it matches the current route. Find more information about the [active-class prop](https://router.vuejs.org/api/#active-class) on the [vue-router](https://router.vuejs.org/) documentation."
},
"v-list-item/active-color": {
"type": "string\n",
"description": "The applied color when the component is in an active state."
},
"v-list-item/href": {
"type": "string\n",
"description": "Designates the component as anchor and applies the **href** attribute."
},
"v-list-item/to": {
"type": "RouteLocationRaw\n",
"description": "Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation."
},
"v-list-item/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-list-item/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-list-item/subtitle": {
"type": "string | number | boolean\n",
"description": "Specify a subtitle text for the component."
},
"v-list-item/append-avatar": {
"type": "string\n",
"description": "Appends a [v-avatar](/components/avatars/) component after default content in the **append** slot."
},
"v-list-item/prepend-avatar": {
"type": "string\n",
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
},
"v-list-item/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-list-item/nav": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListItem.json))"
},
"v-list-item/slim": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListItem.json))"
},
"v-list-item/lines": {
"type": "'one' | 'two' | 'three'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListItem.json))"
},
"v-list-item-action/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-item-action/start": {
"type": "boolean\n",
"description": "Applies margin at the end of the component."
},
"v-list-item-action/end": {
"type": "boolean\n",
"description": "Applies margin at the start of the component."
},
"v-list-item-media/end": {
"type": "boolean\n",
"description": "Applies margin at the start of the component."
},
"v-list-item-media/start": {
"type": "boolean\n",
"description": "Applies margin at the end of the component."
},
"v-list-item-media/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-item-subtitle/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-item-title/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-subheader/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-list-subheader/sticky": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListSubheader.json))"
},
"v-list-subheader/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-list-subheader/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-list-subheader/inset": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VListSubheader.json))"
},
"v-locale-provider/messages": {
"type": "unknown\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-locale-provider/locale": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VLocaleProvider.json))"
},
"v-locale-provider/fallback-locale": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VLocaleProvider.json))"
},
"v-locale-provider/rtl": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VLocaleProvider.json))"
},
"v-main/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-main/scrollable": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VMain.json))"
},
"v-menu/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-menu/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-menu/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-menu/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-menu/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-menu/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component. Use `auto` to use the activator width."
},
"v-menu/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-menu/location": {
"type": "Anchor\n",
"description": "Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both.."
},
"v-menu/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-menu/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-menu/transition": {
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-menu/activator": {
"type": "(string & {}) | Element | 'parent' | ComponentPublicInstance\n",
"description": "Explicitly sets the overlay's activator."
},
"v-menu/close-on-back": {
"type": "boolean\n",
"description": "Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing."
},
"v-menu/contained": {
"type": "boolean\n",
"description": "Limits the size of the component and scrim to its offset parent. Implies `absolute` and `attach`. (Note: The parent element must have position: relative.)."
},
"v-menu/content-class": {
"type": "any\n",
"description": "Applies a custom class to the detached element. This is useful because the content is moved to the beginning of the `v-app` component (unless the **attach** prop is provided) and is not targetable by classes passed directly on the component."
},
"v-menu/content-props": {
"type": "any\n",
"description": "Apply custom properties to the content."
},
"v-menu/no-click-animation": {
"type": "boolean\n",
"description": "Disables the bounce effect when clicking outside of the content element when using the persistent prop."
},
"v-menu/persistent": {
"type": "boolean\n",
"description": "Clicking outside of the element or pressing esc key will not deactivate it."
},
"v-menu/scrim": {
"type": "string | boolean\n",
"description": "Accepts true/false to enable background, and string to define color."
},
"v-menu/z-index": {
"type": "string | number\n",
"description": "The z-index used for the component."
},
"v-menu/target": {
"type": " | (string & {})\n | Element\n | 'parent'\n | 'cursor'\n | ComponentPublicInstance\n | [number, number]\n",
"description": "For locationStrategy=\"connected\", specify an element or array of x,y coordinates that the overlay should position itself relative to. This will be the activator element by default."
},
"v-menu/activator-props": {
"type": "unknown\n",
"description": "Apply custom properties to the activator."
},
"v-menu/open-on-click": {
"type": "boolean\n",
"description": "Designates whether menu should open on activator click."
},
"v-menu/open-on-hover": {
"type": "boolean\n",
"description": "Designates whether menu should open on activator hover."
},
"v-menu/open-on-focus": {
"type": "boolean\n",
"description": "Activate the component when the activator is focused."
},
"v-menu/close-on-content-click": {
"type": "boolean\n",
"description": "Designates if menu should close when its content is clicked."
},
"v-menu/close-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before closing component. Only works with the **open-on-hover** prop."
},
"v-menu/open-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before opening component. Only works with the **open-on-hover** prop."
},
"v-menu/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-menu/location-strategy": {
"type": "'static' | 'connected' | LocationStrategyFn\n",
"description": "A function used to specifies how the component should position relative to its activator."
},
"v-menu/origin": {
"type": "Anchor | 'auto' | 'overlap'\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-menu/offset": {
"type": "string | number | number[]\n",
"description": "A single value that offsets content away from the target based upon what side it is on."
},
"v-menu/scroll-strategy": {
"type": "'close' | 'block' | 'none' | 'reposition' | ScrollStrategyFn\n",
"description": "Strategy used when the component is activate and user scrolls."
},
"v-menu/attach": {
"type": "string | boolean | Element\n",
"description": "Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default. Generally not recommended except as a last resort: the default positioning algorithm should handle most scenarios better than is possible without teleporting, and you may have unexpected behavior if the menu ends up as child of its activator."
},
"v-menu/id": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VMenu.json))"
},
"v-messages/transition": {
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component; leaveAbsolute: boolean; group: boolean }\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-messages/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-messages/active": {
"type": "boolean\n",
"description": "Determines whether the messages are visible or not."
},
"v-messages/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-navigation-drawer/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-navigation-drawer/name": {
"type": "string\n",
"description": "Assign a specific name for layout registration."
},
"v-navigation-drawer/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-navigation-drawer/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the component."
},
"v-navigation-drawer/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-navigation-drawer/scrim": {
"type": "string | boolean\n",
"description": "Determines whether an overlay is used when a **temporary** drawer is open. Accepts true/false to enable background, and string to define color."
},
"v-navigation-drawer/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-navigation-drawer/location": {
"type": "'top' | 'left' | 'right' | 'bottom' | 'start' | 'end'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VNavigationDrawer.json))"
},
"v-navigation-drawer/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-navigation-drawer/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-navigation-drawer/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-navigation-drawer/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-navigation-drawer/sticky": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VNavigationDrawer.json))"
},
"v-navigation-drawer/floating": {
"type": "boolean\n",
"description": "A floating drawer has no visible container (no border-right)."
},
"v-navigation-drawer/image": {
"type": "string\n",
"description": "Apply a specific background image to the component."
},
"v-navigation-drawer/disable-resize-watcher": {
"type": "boolean\n",
"description": "Prevents the automatic opening or closing of the drawer when resized, based on whether the device is mobile or desktop."
},
"v-navigation-drawer/disable-route-watcher": {
"type": "boolean\n",
"description": "Disables opening of navigation drawer when route changes."
},
"v-navigation-drawer/expand-on-hover": {
"type": "boolean\n",
"description": "Collapses the drawer to a **mini-variant** until hovering with the mouse."
},
"v-navigation-drawer/permanent": {
"type": "boolean\n",
"description": "The drawer remains visible regardless of screen size."
},
"v-navigation-drawer/rail": {
"type": "boolean\n",
"description": "Sets the component width to the **rail-width** value."
},
"v-navigation-drawer/rail-width": {
"type": "string | number\n",
"description": "Sets the width for the component when `rail` is enabled."
},
"v-navigation-drawer/temporary": {
"type": "boolean\n",
"description": "A temporary drawer sits above its application and uses a scrim (overlay) to darken the background."
},
"v-navigation-drawer/touchless": {
"type": "boolean\n",
"description": "Disable mobile touch functionality."
},
"v-navigation-drawer/mobile-breakpoint": {
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
"description": "Sets the designated mobile breakpoint for the component. This will apply alternate styles for mobile devices such as the `temporary` prop, or activate the `bottom` prop when the breakpoint value is met. Setting the value to `0` will disable this functionality."
},
"v-navigation-drawer/order": {
"type": "string | number\n",
"description": "Adjust the order of the component in relation to its registration order."
},
"v-otp-input/length": {
"type": "string | number\n",
"description": "The OTP field's length."
},
"v-otp-input/type": {
"type": "'number' | 'text' | 'password'\n",
"description": "Supported types: `text`, `password`, `number`."
},
"v-otp-input/model-value": {
"type": "string | number\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-otp-input/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-otp-input/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-otp-input/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-otp-input/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-otp-input/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-otp-input/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-otp-input/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-otp-input/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-otp-input/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-otp-input/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-otp-input/variant": {
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
"description": "Applies a distinct style to the component."
},
"v-otp-input/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-otp-input/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-otp-input/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-otp-input/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-otp-input/divider": {
"type": "string\n",
"description": "Specifies the dividing character between items."
},
"v-otp-input/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-otp-input/autofocus": {
"type": "boolean\n",
"description": "Automatically focuses the first input on page load"
},
"v-otp-input/placeholder": {
"type": "string\n",
"description": "Sets the input’s placeholder text."
},
"v-otp-input/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-otp-input/focus-all": {
"type": "boolean\n",
"description": "Puts all inputs into a focus state when any are focused"
},
"v-overlay/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-overlay/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-overlay/activator": {
"type": "(string & {}) | Element | 'parent' | ComponentPublicInstance\n",
"description": "Explicitly sets the overlay's activator."
},
"v-overlay/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the content element."
},
"v-overlay/close-on-back": {
"type": "boolean\n",
"description": "Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing."
},
"v-overlay/contained": {
"type": "boolean\n",
"description": "Limits the size of the component and scrim to its offset parent. Implies `absolute` and `attach`. (Note: The parent element must have position: relative.)."
},
"v-overlay/content-class": {
"type": "any\n",
"description": "Applies a custom class to the detached element. This is useful because the content is moved to the beginning of the `v-app` component (unless the **attach** prop is provided) and is not targetable by classes passed directly on the component."
},
"v-overlay/content-props": {
"type": "any\n",
"description": "Apply custom properties to the content."
},
"v-overlay/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-overlay/no-click-animation": {
"type": "boolean\n",
"description": "Disables the bounce effect when clicking outside of the content element when using the persistent prop."
},
"v-overlay/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-overlay/persistent": {
"type": "boolean\n",
"description": "Clicking outside of the element or pressing esc key will not deactivate it."
},
"v-overlay/scrim": {
"type": "string | boolean\n",
"description": "Accepts true/false to enable background, and string to define color."
},
"v-overlay/z-index": {
"type": "string | number\n",
"description": "The z-index used for the component."
},
"v-overlay/target": {
"type": " | (string & {})\n | Element\n | 'parent'\n | 'cursor'\n | ComponentPublicInstance\n | [number, number]\n",
"description": "For locationStrategy=\"connected\", specify an element or array of x,y coordinates that the overlay should position itself relative to. This will be the activator element by default."
},
"v-overlay/activator-props": {
"type": "unknown\n",
"description": "Apply custom properties to the activator."
},
"v-overlay/open-on-click": {
"type": "boolean\n",
"description": "Activate the component when the activator is clicked."
},
"v-overlay/open-on-hover": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VOverlay-activator.json))"
},
"v-overlay/open-on-focus": {
"type": "boolean\n",
"description": "Activate the component when the activator is focused."
},
"v-overlay/close-on-content-click": {
"type": "boolean\n",
"description": "Closes component when you click on its content."
},
"v-overlay/close-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before closing component. Only applies to hover and focus events."
},
"v-overlay/open-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before opening component. Only applies to hover and focus events."
},
"v-overlay/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-overlay/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-overlay/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-overlay/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-overlay/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-overlay/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-overlay/location-strategy": {
"type": "'static' | 'connected' | LocationStrategyFn\n",
"description": "A function used to specifies how the component should position relative to its activator."
},
"v-overlay/location": {
"type": "Anchor\n",
"description": "Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both.."
},
"v-overlay/origin": {
"type": "Anchor | 'auto' | 'overlap'\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-overlay/offset": {
"type": "string | number | number[]\n",
"description": "A single value that offsets content away from the target based upon what side it is on."
},
"v-overlay/scroll-strategy": {
"type": "'none' | 'close' | 'block' | 'reposition' | ScrollStrategyFn\n",
"description": "Strategy used when the component is activate and user scrolls."
},
"v-overlay/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-overlay/attach": {
"type": "string | boolean | Element\n",
"description": "Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default."
},
"v-pagination/length": {
"type": "string | number\n",
"description": "The number of pages."
},
"v-pagination/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-pagination/start": {
"type": "string | number\n",
"description": "Specify the starting page."
},
"v-pagination/model-value": {
"type": "number\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-pagination/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-pagination/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-pagination/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-pagination/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-pagination/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-pagination/color": {
"type": "string\n",
"description": "Applies specified color to the selected page button - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-pagination/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-pagination/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-pagination/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-pagination/active-color": {
"type": "string\n",
"description": "The applied color when the component is in an active state."
},
"v-pagination/next-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon to use for the next button."
},
"v-pagination/prev-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon to use for the prev button."
},
"v-pagination/first-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon to use for the first button."
},
"v-pagination/last-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon to use for the last button."
},
"v-pagination/aria-label": {
"type": "string\n",
"description": "Label for the root element."
},
"v-pagination/total-visible": {
"type": "string | number\n",
"description": "Specify the total visible pagination numbers."
},
"v-pagination/page-aria-label": {
"type": "string\n",
"description": "Label for each page button."
},
"v-pagination/current-page-aria-label": {
"type": "string\n",
"description": "Label for the currently selected page."
},
"v-pagination/first-aria-label": {
"type": "string\n",
"description": "Label for the go to first button."
},
"v-pagination/previous-aria-label": {
"type": "string\n",
"description": "Label for the previous button."
},
"v-pagination/next-aria-label": {
"type": "string\n",
"description": "Label for the next button."
},
"v-pagination/last-aria-label": {
"type": "string\n",
"description": "Label for the go to last button."
},
"v-pagination/ellipsis": {
"type": "string\n",
"description": "Text to show between page buttons when truncating the list."
},
"v-pagination/show-first-last-page": {
"type": "boolean\n",
"description": "Show buttons for going to first and last page."
},
"v-parallax/scale": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VParallax.json))"
},
"v-picker/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-picker/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-picker/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-picker/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-picker/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-picker/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-picker/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-picker/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-picker/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-picker/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-picker/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-picker/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-picker/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-picker/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-picker/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-picker/position": {
"type": "'fixed' | 'relative' | 'absolute' | 'static' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-picker/landscape": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VPicker.json))"
},
"v-picker/hide-header": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VPicker.json))"
},
"v-picker-title/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-progress-circular/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-progress-circular/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-progress-circular/model-value": {
"type": "string | number\n",
"description": "The percentage value for current progress."
},
"v-progress-circular/width": {
"type": "string | number\n",
"description": "Sets the stroke of the circle in pixels."
},
"v-progress-circular/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-progress-circular/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-progress-circular/indeterminate": {
"type": "boolean | 'disable-shrink'\n",
"description": "Constantly animates, use when loading progress is unknown. If set to the string `'disable-shrink'` it will use a simpler animation that does not run on the main thread."
},
"v-progress-circular/size": {
"type": "string | number\n",
"description": "Sets the diameter of the circle in pixels."
},
"v-progress-circular/rotate": {
"type": "string | number\n",
"description": "Rotates the circle start point in degrees."
},
"v-progress-linear/model-value": {
"type": "string | number\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-progress-linear/reverse": {
"type": "boolean\n",
"description": "Displays reversed progress (right to left in LTR mode and left to right in RTL)."
},
"v-progress-linear/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-progress-linear/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-progress-linear/absolute": {
"type": "boolean\n",
"description": "Applies position: absolute to the component."
},
"v-progress-linear/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-progress-linear/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-progress-linear/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-progress-linear/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-progress-linear/active": {
"type": "boolean\n",
"description": "Reduce the height to 0, hiding component."
},
"v-progress-linear/max": {
"type": "string | number\n",
"description": "Sets the maximum value the progress can reach."
},
"v-progress-linear/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-progress-linear/indeterminate": {
"type": "boolean\n",
"description": "Constantly animates, use when loading progress is unknown."
},
"v-progress-linear/clickable": {
"type": "boolean\n",
"description": "Clicking on the progress track will automatically set the value."
},
"v-progress-linear/bg-opacity": {
"type": "string | number\n",
"description": "Background opacity, if null it defaults to 0.3 if background color is not specified or 1 otherwise."
},
"v-progress-linear/buffer-value": {
"type": "string | number\n",
"description": "The percentage value for the buffer."
},
"v-progress-linear/stream": {
"type": "boolean\n",
"description": "An alternative style for portraying loading that works in tandem with **buffer-value**."
},
"v-progress-linear/striped": {
"type": "boolean\n",
"description": "Adds a stripe background to the filled portion of the progress component."
},
"v-progress-linear/rounded-bar": {
"type": "boolean\n",
"description": "Applies a border radius to the progress bar."
},
"v-radio/type": {
"type": "string\n",
"description": "Provides the default type for children selection controls."
},
"v-radio/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-radio/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-radio/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-radio/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-radio/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-radio/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-radio/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-radio/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-radio/multiple": {
"type": "boolean\n",
"description": "Changes select to multiple. Accepts array for value."
},
"v-radio/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-radio/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-radio/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-radio/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-radio/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSelectionControl.json))"
},
"v-radio/inline": {
"type": "boolean\n",
"description": "Puts children inputs into a row."
},
"v-radio/true-value": {
"type": "any\n",
"description": "Sets value for truthy state."
},
"v-radio/false-value": {
"type": "any\n",
"description": "Sets value for falsy state."
},
"v-radio/defaults-target": {
"type": "string\n",
"description": "The target component to provide defaults values for."
},
"v-radio/false-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when inactive."
},
"v-radio/true-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when active."
},
"v-radio/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-radio-group/type": {
"type": "string\n",
"description": "Provides the default type for children selection controls."
},
"v-radio-group/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-radio-group/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-radio-group/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-radio-group/height": {
"type": "string | number\n",
"description": "Sets the height of the input."
},
"v-radio-group/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-radio-group/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-radio-group/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-radio-group/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-radio-group/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-radio-group/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-radio-group/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-radio-group/inline": {
"type": "boolean\n",
"description": "Displays radio buttons in row."
},
"v-radio-group/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-radio-group/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-radio-group/defaults-target": {
"type": "string\n",
"description": "The target component to provide defaults values for."
},
"v-radio-group/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-radio-group/false-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when inactive."
},
"v-radio-group/true-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when active."
},
"v-radio-group/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-radio-group/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-radio-group/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-radio-group/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-radio-group/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-radio-group/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-radio-group/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-radio-group/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-radio-group/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-radio-group/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-radio-group/validate-on": {
"type": " | 'lazy'\n | 'input'\n | 'blur'\n | 'submit'\n | 'input lazy'\n | 'blur lazy'\n | 'submit lazy'\n | 'lazy input'\n | 'lazy blur'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-radio-group/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-radio-group/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-radio-group/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-range-slider/reverse": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-range-slider/id": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VInput.json))"
},
"v-range-slider/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-range-slider/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-range-slider/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-range-slider/model-value": {
"type": "(string | number)[]\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-range-slider/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-range-slider/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-range-slider/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-range-slider/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-range-slider/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-range-slider/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-range-slider/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-range-slider/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-range-slider/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-range-slider/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-range-slider/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-range-slider/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-range-slider/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-range-slider/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-range-slider/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-range-slider/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-range-slider/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-range-slider/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-range-slider/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-range-slider/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-range-slider/max": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-range-slider/min": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/step": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/thumb-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/thumb-label": {
"type": "boolean | 'always'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/thumb-size": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/show-ticks": {
"type": "boolean | 'always'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/ticks": {
"type": "number[] | Record\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/tick-size": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/track-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/track-fill-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/track-size": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-range-slider/strict": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VRangeSlider.json))"
},
"v-rating/length": {
"type": "string | number\n",
"description": "The amount of items to show."
},
"v-rating/model-value": {
"type": "string | number\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-rating/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-rating/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-rating/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-rating/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-rating/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-rating/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-rating/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-rating/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-rating/active-color": {
"type": "string\n",
"description": "The applied color when the component is in an active state."
},
"v-rating/hover": {
"type": "boolean\n",
"description": "Provides visual feedback when hovering over icons."
},
"v-rating/readonly": {
"type": "boolean\n",
"description": "Removes all hover effects and pointer events."
},
"v-rating/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared by clicking on the current value."
},
"v-rating/item-aria-label": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VRating.json))"
},
"v-rating/empty-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon displayed when empty."
},
"v-rating/full-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon displayed when full."
},
"v-rating/half-increments": {
"type": "boolean\n",
"description": "Allows the selection of half increments."
},
"v-rating/item-label-position": {
"type": "string\n",
"description": "Position of item labels. Accepts 'top' and 'bottom'."
},
"v-rating/item-labels": {
"type": "string[]\n",
"description": "Array of labels to display next to each item.."
},
"v-responsive/content-class": {
"type": "string\n",
"description": "Apply a custom class to the internal content element."
},
"v-responsive/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-responsive/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-responsive/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-responsive/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-responsive/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-responsive/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-responsive/aspect-ratio": {
"type": "string | number\n",
"description": "Sets a base aspect ratio, calculated as width/height. This will only set a **minimum** height, the component can still grow if it has a lot of content."
},
"v-responsive/inline": {
"type": "boolean\n",
"description": "Display as an inline element instead of a block, also disables flex-grow."
},
"v-row/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-row/align": {
"type": "'start' | 'end' | 'center' | 'baseline' | 'stretch'\n",
"description": "Applies the [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) css property. Available options are: **start**, **center**, **end**, **baseline** and **stretch**."
},
"v-row/dense": {
"type": "boolean\n",
"description": "Reduces the gutter between `v-col`s."
},
"v-row/no-gutters": {
"type": "boolean\n",
"description": "Removes the gutter between `v-col`s."
},
"v-row/align-sm": {
"type": "'start' | 'end' | 'center' | 'baseline' | 'stretch'\n",
"description": "Changes the **align-items** property on small and greater breakpoints."
},
"v-row/align-md": {
"type": "'start' | 'end' | 'center' | 'baseline' | 'stretch'\n",
"description": "Changes the **align-items** property on medium and greater breakpoints."
},
"v-row/align-lg": {
"type": "'start' | 'end' | 'center' | 'baseline' | 'stretch'\n",
"description": "Changes the **align-items** property on large and greater breakpoints."
},
"v-row/align-xl": {
"type": "'start' | 'end' | 'center' | 'baseline' | 'stretch'\n",
"description": "Changes the **align-items** property on extra large and greater breakpoints."
},
"v-row/align-xxl": {
"type": "'start' | 'end' | 'center' | 'baseline' | 'stretch'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VRow.json))"
},
"v-row/justify-sm": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **justify-content** property on small and greater breakpoints."
},
"v-row/justify-md": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **justify-content** property on medium and greater breakpoints."
},
"v-row/justify-lg": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **justify-content** property on large and greater breakpoints."
},
"v-row/justify-xl": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **justify-content** property on extra large and greater breakpoints."
},
"v-row/justify-xxl": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VRow.json))"
},
"v-row/align-content-sm": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'stretch'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **align-content** property on small and greater breakpoints."
},
"v-row/align-content-md": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'stretch'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **align-content** property on medium and greater breakpoints."
},
"v-row/align-content-lg": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'stretch'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **align-content** property on large and greater breakpoints."
},
"v-row/align-content-xl": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'stretch'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Changes the **align-content** property on extra large and greater breakpoints."
},
"v-row/align-content-xxl": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'stretch'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VRow.json))"
},
"v-row/justify": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'stretch'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Applies the [justify-content](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content) css property. Available options are: **start**, **center**, **end**, **space-between** and **space-around**."
},
"v-row/align-content": {
"type": " | 'start'\n | 'end'\n | 'center'\n | 'stretch'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'\n",
"description": "Applies the [align-content](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content) css property. Available options are: **start**, **center**, **end**, **space-between**, **space-around** and **stretch**."
},
"v-scale-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-scale-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-scale-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-scale-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-scale-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-scale-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-scroll-x-reverse-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-scroll-x-reverse-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-scroll-x-reverse-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-scroll-x-reverse-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-scroll-x-reverse-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-scroll-x-reverse-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-scroll-x-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-scroll-x-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-scroll-x-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-scroll-x-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-scroll-x-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-scroll-x-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-scroll-y-reverse-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-scroll-y-reverse-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-scroll-y-reverse-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-scroll-y-reverse-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-scroll-y-reverse-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-scroll-y-reverse-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-scroll-y-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-scroll-y-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-scroll-y-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-scroll-y-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-scroll-y-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-scroll-y-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-select/flat": {
"type": "boolean\n",
"description": "Removes box shadow when using a variant with elevation."
},
"v-select/type": {
"type": "string\n",
"description": "Sets input type."
},
"v-select/reverse": {
"type": "boolean\n",
"description": "Reverses the orientation."
},
"v-select/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-select/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-select/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-select/items": {
"type": "any[]\n",
"description": "Can be an array of objects or strings. By default objects should have **title** and **value** properties, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props). Keys to use for these can be changed with the **item-title**, **item-value**, and **item-props** props."
},
"v-select/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-select/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-select/chips": {
"type": "boolean\n",
"description": "Changes display of selections to chips."
},
"v-select/closable-chips": {
"type": "boolean\n",
"description": "Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components."
},
"v-select/close-text": {
"type": "string\n",
"description": "Text set to to the inputs `aria-label` and `title` when input menu is closed."
},
"v-select/open-text": {
"type": "string\n",
"description": "Text set to to the inputs **aria-label** and **title** when input menu is open."
},
"v-select/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-select/hide-no-data": {
"type": "boolean\n",
"description": "Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open."
},
"v-select/hide-selected": {
"type": "boolean\n",
"description": "Do not display in the select menu items that are already selected."
},
"v-select/menu": {
"type": "boolean\n",
"description": "Renders with the menu open by default."
},
"v-select/menu-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Sets the the spin icon."
},
"v-select/menu-props": {
"type": "unknown\n",
"description": "Pass props through to the `v-menu` component. Accepts an object with anything from [v-menu](/api/v-menu/#props) props, camelCase keys are recommended."
},
"v-select/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-select/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-select/transition": {
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-select/multiple": {
"type": "boolean\n",
"description": "Changes select to multiple. Accepts array for value."
},
"v-select/no-data-text": {
"type": "string\n",
"description": "Text shown when no items are provided to the component."
},
"v-select/open-on-clear": {
"type": "boolean\n",
"description": "When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state."
},
"v-select/item-color": {
"type": "string\n",
"description": "Sets color of selected items."
},
"v-select/item-title": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its title."
},
"v-select/item-value": {
"type": "SelectItemKey\n",
"description": "Set property of **items**'s value - **must be primitive**. Dot notation is supported. **Note:** This is currently not supported with `v-combobox` [GitHub Issue](https://github.com/vuetifyjs/vuetify/issues/5479)."
},
"v-select/item-children": {
"type": "SelectItemKey\n",
"description": "Property on supplied `items` that contains its children."
},
"v-select/item-props": {
"type": "SelectItemKey\n",
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
},
"v-select/return-object": {
"type": "boolean\n",
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
},
"v-select/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-select/autofocus": {
"type": "boolean\n",
"description": "Enables autofocus."
},
"v-select/counter": {
"type": "string | number | boolean\n",
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
},
"v-select/prefix": {
"type": "string\n",
"description": "Displays prefix text."
},
"v-select/placeholder": {
"type": "string\n",
"description": "Sets the input’s placeholder text."
},
"v-select/persistent-placeholder": {
"type": "boolean\n",
"description": "Forces placeholder to always be visible."
},
"v-select/persistent-counter": {
"type": "boolean\n",
"description": "Forces counter to always be visible."
},
"v-select/suffix": {
"type": "string\n",
"description": "Displays suffix text."
},
"v-select/role": {
"type": "string\n",
"description": "The role attribute applied to the input."
},
"v-select/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-select/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-select/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
},
"v-select/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-select/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-select/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-select/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-select/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-select/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-select/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-select/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-select/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-select/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-select/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-select/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-select/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-select/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-select/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared."
},
"v-select/clear-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when the **clearable** prop is set to true."
},
"v-select/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-select/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-select/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-select/persistent-clear": {
"type": "boolean\n",
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
},
"v-select/prepend-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
},
"v-select/single-line": {
"type": "boolean\n",
"description": "Label does not move on focus/dirty."
},
"v-select/variant": {
"type": " | 'underlined'\n | 'outlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-select/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-select/rounded": {
"type": "string | number | boolean\n",
"description": "Adds a border radius to the input."
},
"v-select/counter-value": {
"type": "number | ((value: any) => number)\n",
"description": "Function returns the counter display text."
},
"v-select/model-modifiers": {
"type": "unknown\n",
"description": "**FOR INTERNAL USE ONLY**"
},
"v-selection-control/type": {
"type": "string\n",
"description": "Provides the default type for children selection controls."
},
"v-selection-control/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-selection-control/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-selection-control/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-selection-control/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-selection-control/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-selection-control/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-selection-control/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-selection-control/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-selection-control/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-selection-control/inline": {
"type": "boolean\n",
"description": "Puts children inputs into a row."
},
"v-selection-control/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-selection-control/multiple": {
"type": "boolean\n",
"description": "Changes select to multiple. Accepts array for value."
},
"v-selection-control/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSelectionControl.json))"
},
"v-selection-control/true-value": {
"type": "any\n",
"description": "Sets value for truthy state."
},
"v-selection-control/false-value": {
"type": "any\n",
"description": "Sets value for falsy state."
},
"v-selection-control/defaults-target": {
"type": "string\n",
"description": "The target component to provide defaults values for."
},
"v-selection-control/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-selection-control/false-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when inactive."
},
"v-selection-control/true-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when active."
},
"v-selection-control/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-selection-control/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-selection-control-group/type": {
"type": "string\n",
"description": "Provides the default type for children selection controls."
},
"v-selection-control-group/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-selection-control-group/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-selection-control-group/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-selection-control-group/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-selection-control-group/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-selection-control-group/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-selection-control-group/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-selection-control-group/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-selection-control-group/inline": {
"type": "boolean\n",
"description": "Puts children inputs into a row."
},
"v-selection-control-group/multiple": {
"type": "boolean\n",
"description": "Changes select to multiple. Accepts array for value."
},
"v-selection-control-group/defaults-target": {
"type": "string\n",
"description": "The target component to provide defaults values for."
},
"v-selection-control-group/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-selection-control-group/false-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when inactive."
},
"v-selection-control-group/true-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when active."
},
"v-selection-control-group/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-selection-control-group/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-sheet/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-sheet/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-sheet/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-sheet/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-sheet/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-sheet/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-sheet/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-sheet/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-sheet/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-sheet/position": {
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-sheet/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-sheet/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-sheet/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-sheet/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-skeleton-loader/type": {
"type": " | 'text'\n | (string & {})\n | 'image'\n | 'button'\n | 'actions'\n | 'avatar'\n | 'divider'\n | 'subtitle'\n | 'chip'\n | 'heading'\n | 'sentences'\n | 'paragraph'\n | 'ossein'\n | 'article'\n | 'card'\n | 'card-avatar'\n | 'date-picker'\n | 'date-picker-options'\n | 'date-picker-days'\n | 'list-item'\n | 'list-item-avatar'\n | 'list-item-two-line'\n | 'list-item-avatar-two-line'\n | 'list-item-three-line'\n | 'list-item-avatar-three-line'\n | 'table'\n | 'table-heading'\n | 'table-thead'\n | 'table-tbody'\n | 'table-row-divider'\n | 'table-row'\n | 'table-tfoot'\n | (\n | 'text'\n | (string & {})\n | 'image'\n | 'button'\n | 'actions'\n | 'avatar'\n | 'divider'\n | 'subtitle'\n | 'chip'\n | 'heading'\n | 'sentences'\n | 'paragraph'\n | 'ossein'\n | 'article'\n | 'card'\n | 'card-avatar'\n | 'date-picker'\n | 'date-picker-options'\n | 'date-picker-days'\n | 'list-item'\n | 'list-item-avatar'\n | 'list-item-two-line'\n | 'list-item-avatar-two-line'\n | 'list-item-three-line'\n | 'list-item-avatar-three-line'\n | 'table'\n | 'table-heading'\n | 'table-thead'\n | 'table-tbody'\n | 'table-row-divider'\n | 'table-row'\n | 'table-tfoot'\n )[]\n",
"description": "A string delimited list of skeleton components to create such as `type=\"text@3\"` or `type=\"card, list-item\"`. Will recursively generate a corresponding skeleton from the provided string. Also supports short-hand for multiple elements such as **article@3** and **paragraph@2** which will generate 3 _article_ skeletons and 2 _paragraph_ skeletons. Please see below for a list of available pre-defined options."
},
"v-skeleton-loader/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-skeleton-loader/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-skeleton-loader/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-skeleton-loader/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-skeleton-loader/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-skeleton-loader/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-skeleton-loader/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-skeleton-loader/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-skeleton-loader/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-skeleton-loader/loading": {
"type": "boolean\n",
"description": "Applies a loading animation with a on-hover loading cursor. A value of **false** will only work when there is content in the `default` slot."
},
"v-skeleton-loader/loading-text": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSkeletonLoader.json))"
},
"v-skeleton-loader/boilerplate": {
"type": "boolean\n",
"description": "Remove the loading animation from the skeleton."
},
"v-slide-group/symbol": {
"type": "any\n",
"description": "The [Symbol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) used to hook into group functionality for components like [v-btn-toggle](/components/btn-toggle) and [v-bottom-navigation](/components/bottom-navigations/)."
},
"v-slide-group/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-slide-group/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-slide-group/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-slide-group/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-slide-group/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSlideGroup.json))"
},
"v-slide-group/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-slide-group/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-slide-group/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-slide-group/prev-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The prepended slot when arrows are shown."
},
"v-slide-group/next-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The appended slot when arrows are shown."
},
"v-slide-group/mobile-breakpoint": {
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
"description": "Sets the designated mobile breakpoint for the component."
},
"v-slide-group/center-active": {
"type": "boolean\n",
"description": "Forces the selected component to be centered."
},
"v-slide-group/show-arrows": {
"type": "string | boolean\n",
"description": "Change when the overflow arrow indicators are shown. By **default**, arrows *always* display on Desktop when the container is overflowing. When the container overflows on mobile, arrows are not shown by default. A **show-arrows** value of `true` allows these arrows to show on Mobile if the container overflowing. A value of `desktop` *always* displays arrows on Desktop while a value of `mobile` always displays arrows on Mobile. A value of `always` always displays arrows on Desktop *and* Mobile. Find more information on how to customize breakpoint thresholds on the [breakpoints page](/customizing/breakpoints)."
},
"v-slide-group-item/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-slide-group-item/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-slide-group-item/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-slide-x-reverse-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-slide-x-reverse-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-slide-x-reverse-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-slide-x-reverse-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-slide-x-reverse-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-slide-x-reverse-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-slide-x-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-slide-x-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-slide-x-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-slide-x-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-slide-x-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-slide-x-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-slide-y-reverse-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-slide-y-reverse-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-slide-y-reverse-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-slide-y-reverse-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-slide-y-reverse-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-slide-y-reverse-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-slide-y-transition/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-slide-y-transition/origin": {
"type": "string\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-slide-y-transition/mode": {
"type": "string\n",
"description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/api/built-in-components.html#transition)."
},
"v-slide-y-transition/group": {
"type": "boolean\n",
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
},
"v-slide-y-transition/hide-on-leave": {
"type": "boolean\n",
"description": "Hides the leaving element (no exit animation)."
},
"v-slide-y-transition/leave-absolute": {
"type": "boolean\n",
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
},
"v-slider/model-value": {
"type": "string | number\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-slider/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-slider/reverse": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-slider/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-slider/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-slider/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-slider/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-slider/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-slider/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-slider/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-slider/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-slider/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-slider/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-slider/max": {
"type": "string | number\n",
"description": "Sets the maximum allowed value."
},
"v-slider/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-slider/id": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VInput.json))"
},
"v-slider/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-slider/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-slider/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-slider/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-slider/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-slider/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-slider/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-slider/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-slider/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-slider/validate-on": {
"type": " | 'lazy'\n | 'input'\n | 'blur'\n | 'submit'\n | 'input lazy'\n | 'blur lazy'\n | 'submit lazy'\n | 'lazy input'\n | 'lazy blur'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-slider/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-slider/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-slider/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-slider/min": {
"type": "string | number\n",
"description": "Sets the minimum allowed value."
},
"v-slider/step": {
"type": "string | number\n",
"description": "If greater than 0, sets step interval for ticks."
},
"v-slider/thumb-color": {
"type": "string\n",
"description": "Sets the thumb and thumb label color."
},
"v-slider/thumb-label": {
"type": "boolean | 'always'\n",
"description": "Show thumb label. If `true` it shows label when using slider. If set to `'always'` it always shows label."
},
"v-slider/thumb-size": {
"type": "string | number\n",
"description": "Controls the size of the thumb label."
},
"v-slider/show-ticks": {
"type": "boolean | 'always'\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-slider/ticks": {
"type": "number[] | Record\n",
"description": "Show track ticks. If `true` it shows ticks when using slider. If set to `'always'` it always shows ticks."
},
"v-slider/tick-size": {
"type": "string | number\n",
"description": "Controls the size of **ticks**"
},
"v-slider/track-color": {
"type": "string\n",
"description": "Sets the track's color"
},
"v-slider/track-fill-color": {
"type": "string\n",
"description": "Sets the track's fill color"
},
"v-slider/track-size": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/Slider.json))"
},
"v-snackbar/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-snackbar/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-snackbar/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-snackbar/activator": {
"type": "(string & {}) | Element | 'parent' | ComponentPublicInstance\n",
"description": "Explicitly sets the overlay's activator."
},
"v-snackbar/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the content element."
},
"v-snackbar/close-on-back": {
"type": "boolean\n",
"description": "Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing."
},
"v-snackbar/contained": {
"type": "boolean\n",
"description": "Limits the size of the component and scrim to its offset parent. Implies `absolute` and `attach`. (Note: The parent element must have position: relative.)."
},
"v-snackbar/content-class": {
"type": "any\n",
"description": "Applies a custom class to the detached element. This is useful because the content is moved to the beginning of the `v-app` component (unless the **attach** prop is provided) and is not targetable by classes passed directly on the component."
},
"v-snackbar/content-props": {
"type": "any\n",
"description": "Apply custom properties to the content."
},
"v-snackbar/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-snackbar/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-snackbar/z-index": {
"type": "string | number\n",
"description": "The z-index used for the component."
},
"v-snackbar/target": {
"type": " | (string & {})\n | Element\n | 'parent'\n | 'cursor'\n | ComponentPublicInstance\n | [number, number]\n",
"description": "For locationStrategy=\"connected\", specify an element or array of x,y coordinates that the overlay should position itself relative to. This will be the activator element by default."
},
"v-snackbar/activator-props": {
"type": "unknown\n",
"description": "Apply custom properties to the activator."
},
"v-snackbar/open-on-click": {
"type": "boolean\n",
"description": "Activate the component when the activator is clicked."
},
"v-snackbar/open-on-hover": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VOverlay-activator.json))"
},
"v-snackbar/open-on-focus": {
"type": "boolean\n",
"description": "Activate the component when the activator is focused."
},
"v-snackbar/close-on-content-click": {
"type": "boolean\n",
"description": "Closes component when you click on its content."
},
"v-snackbar/close-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before closing component. Only applies to hover and focus events."
},
"v-snackbar/open-delay": {
"type": "string | number\n",
"description": "Milliseconds to wait before opening component. Only applies to hover and focus events."
},
"v-snackbar/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-snackbar/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-snackbar/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-snackbar/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-snackbar/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-snackbar/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-snackbar/location-strategy": {
"type": "'static' | 'connected' | LocationStrategyFn\n",
"description": "A function used to specifies how the component should position relative to its activator."
},
"v-snackbar/location": {
"type": "Anchor\n",
"description": "Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both.."
},
"v-snackbar/origin": {
"type": "Anchor | 'auto' | 'overlap'\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-snackbar/offset": {
"type": "string | number | number[]\n",
"description": "A single value that offsets content away from the target based upon what side it is on."
},
"v-snackbar/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-snackbar/attach": {
"type": "string | boolean | Element\n",
"description": "Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default."
},
"v-snackbar/vertical": {
"type": "boolean\n",
"description": "Stacks snackbar content on top of the actions (button)."
},
"v-snackbar/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-snackbar/variant": {
"type": "'flat' | 'text' | 'outlined' | 'plain' | 'elevated' | 'tonal'\n",
"description": "Applies a distinct style to the component."
},
"v-snackbar/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-snackbar/position": {
"type": "'fixed' | 'relative' | 'absolute' | 'static' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-snackbar/multi-line": {
"type": "boolean\n",
"description": "Gives the snackbar a larger minimum height."
},
"v-snackbar/timer": {
"type": "string | boolean\n",
"description": "Display a progress bar that counts down until the snackbar closes. Pass a string to set a custom color, otherwise uses `info`."
},
"v-snackbar/timeout": {
"type": "string | number\n",
"description": "Time (in milliseconds) to wait until snackbar is automatically hidden. Use `-1` to keep open indefinitely (`0` in version < 2.3 ). It is recommended for this number to be between `4000` and `10000`. Changes to this property will reset the timeout."
},
"v-spacer/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-stepper/flat": {
"type": "boolean\n",
"description": "Removes the stepper's elevation."
},
"v-stepper/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-stepper/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-stepper/items": {
"type": "(string | Record)[]\n",
"description": "An array of strings or objects used for automatically generating children components."
},
"v-stepper/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-stepper/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-stepper/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-stepper/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-stepper/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-stepper/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-stepper/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-stepper/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-stepper/location": {
"type": "Anchor\n",
"description": "Specifies the component's location. Can combine by using a space separated string."
},
"v-stepper/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-stepper/item-title": {
"type": "string\n",
"description": "Property on supplied `items` that contains its title."
},
"v-stepper/item-value": {
"type": "string\n",
"description": "Property on supplied `items` that contains its value."
},
"v-stepper/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-stepper/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-stepper/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-stepper/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-stepper/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-stepper/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-stepper/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-stepper/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-stepper/position": {
"type": "'fixed' | 'relative' | 'absolute' | 'static' | 'sticky'\n",
"description": "Sets the position for the component."
},
"v-stepper/mobile": {
"type": "boolean\n",
"description": "Forces the stepper into a mobile state, removing labels from stepper items."
},
"v-stepper/alt-labels": {
"type": "boolean\n",
"description": "Places the labels beneath the step."
},
"v-stepper/editable": {
"type": "boolean\n",
"description": "Marks step as editable."
},
"v-stepper/hide-actions": {
"type": "boolean\n",
"description": "Hide actions bar (prev and next buttons)."
},
"v-stepper/non-linear": {
"type": "boolean\n",
"description": "Allow user to jump to any step."
},
"v-stepper/prev-text": {
"type": "string\n",
"description": "The text used for the Prev button."
},
"v-stepper/next-text": {
"type": "string\n",
"description": "The text used for the Next button."
},
"v-stepper-actions/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-stepper-actions/disabled": {
"type": "boolean | 'prev' | 'next'\n",
"description": "Removes the ability to click or target the component."
},
"v-stepper-actions/prev-text": {
"type": "string\n",
"description": "The text used for the Prev button."
},
"v-stepper-actions/next-text": {
"type": "string\n",
"description": "The text used for the Next button."
},
"v-stepper-header/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-stepper-item/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-stepper-item/icon": {
"type": "string\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-stepper-item/error": {
"type": "boolean\n",
"description": "Puts the stepper item in a manual error state."
},
"v-stepper-item/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-stepper-item/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-stepper-item/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-stepper-item/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-stepper-item/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-stepper-item/subtitle": {
"type": "string\n",
"description": "Specify a subtitle text for the component."
},
"v-stepper-item/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-stepper-item/complete": {
"type": "boolean\n",
"description": "Marks step as complete."
},
"v-stepper-item/complete-icon": {
"type": "string\n",
"description": "Icon to display when step is marked as completed."
},
"v-stepper-item/editable": {
"type": "boolean\n",
"description": "Marks step as editable."
},
"v-stepper-item/edit-icon": {
"type": "string\n",
"description": "Icon to display when step is editable."
},
"v-stepper-item/error-icon": {
"type": "string\n",
"description": "Icon to display when step has an error."
},
"v-stepper-window/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-stepper-window/reverse": {
"type": "boolean\n",
"description": "Reverse the normal transition direction."
},
"v-stepper-window/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-stepper-window/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-stepper-window/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-stepper-window/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "The transition direction when changing windows."
},
"v-stepper-window/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-stepper-window-item/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-stepper-window-item/disabled": {
"type": "boolean\n",
"description": "Prevents the item from becoming active when using the \"next\" and \"prev\" buttons or the `toggle` method."
},
"v-stepper-window-item/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-stepper-window-item/transition": {
"type": "string | boolean\n",
"description": "The transition used when the component progressing through items. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-stepper-window-item/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-stepper-window-item/reverse-transition": {
"type": "string | boolean\n",
"description": "Sets the reverse transition."
},
"v-svg-icon/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-svg-icon/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
},
"v-switch/flat": {
"type": "boolean\n",
"description": "Display component without elevation. Default elevation for thumb is 4dp, `flat` resets it."
},
"v-switch/type": {
"type": "string\n",
"description": "Provides the default type for children selection controls."
},
"v-switch/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-switch/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-switch/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-switch/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-switch/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-switch/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-switch/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-switch/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-switch/ripple": {
"type": "boolean\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-switch/value": {
"type": "any\n",
"description": "The input's value."
},
"v-switch/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-switch/loading": {
"type": "string | boolean\n",
"description": "Displays circular progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - primary, secondary, success, info, warning, error) or a Boolean which uses the component color (set by color prop - if it's supported by the component) or the primary color."
},
"v-switch/inline": {
"type": "boolean\n",
"description": "Puts children inputs into a row."
},
"v-switch/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-switch/multiple": {
"type": "boolean\n",
"description": "Changes expected model to an array."
},
"v-switch/inset": {
"type": "boolean\n",
"description": "Enlarge the `v-switch` track to encompass the thumb."
},
"v-switch/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-switch/indeterminate": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSwitch.json))"
},
"v-switch/base-color": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VSelectionControl.json))"
},
"v-switch/true-value": {
"type": "any\n",
"description": "Sets value for truthy state."
},
"v-switch/false-value": {
"type": "any\n",
"description": "Sets value for falsy state."
},
"v-switch/defaults-target": {
"type": "string\n",
"description": "The target component to provide defaults values for."
},
"v-switch/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-switch/false-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when inactive."
},
"v-switch/true-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when active."
},
"v-switch/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-switch/value-comparator": {
"type": "(a: any, b: any) => boolean\n",
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
},
"v-switch/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-switch/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-switch/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-switch/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-switch/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-switch/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-switch/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-switch/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-switch/validate-on": {
"type": " | 'lazy'\n | 'input'\n | 'blur'\n | 'submit'\n | 'input lazy'\n | 'blur lazy'\n | 'submit lazy'\n | 'lazy input'\n | 'lazy blur'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-switch/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-switch/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-switch/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-system-bar/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-system-bar/name": {
"type": "string\n",
"description": "Assign a specific name for layout registration."
},
"v-system-bar/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-system-bar/absolute": {
"type": "boolean\n",
"description": "Applies **position: absolute** to the component."
},
"v-system-bar/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-system-bar/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-system-bar/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-system-bar/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-system-bar/order": {
"type": "string | number\n",
"description": "Adjust the order of the component in relation to its registration order."
},
"v-system-bar/window": {
"type": "boolean\n",
"description": "Increases the system bar height to 32px (24px default)."
},
"v-tab/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-tab/replace": {
"type": "boolean\n",
"description": "Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [replace](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
},
"v-tab/fixed": {
"type": "boolean\n",
"description": "Forces component to take up all available space up to their maximum width (300px), and centers it."
},
"v-tab/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-tab/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-tab/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-tab/exact": {
"type": "boolean\n",
"description": "Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation."
},
"v-tab/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-tab/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-tab/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-tab/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-tab/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-tab/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-tab/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-tab/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-tab/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
},
"v-tab/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the tabs. Can be either `horizontal` or `vertical`."
},
"v-tab/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-tab/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-tab/variant": {
"type": "'flat' | 'text' | 'outlined' | 'plain' | 'elevated' | 'tonal'\n",
"description": "Applies a distinct style to the component."
},
"v-tab/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-tab/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-tab/href": {
"type": "string\n",
"description": "Designates the component as anchor and applies the **href** attribute."
},
"v-tab/to": {
"type": "RouteLocationRaw\n",
"description": "Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation."
},
"v-tab/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-tab/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-tab/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-tab/ripple": {
"type": "boolean | { class: string }\n",
"description": "Applies the [v-ripple](/directives/ripple) directive."
},
"v-tab/size": {
"type": "string | number\n",
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
},
"v-tab/icon": {
"type": " | boolean\n | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component. The button will become _round_."
},
"v-tab/slim": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VBtn.json))"
},
"v-tab/slider-color": {
"type": "string\n",
"description": "Applies specified color to the slider when active on that component - supports utility colors (for example success or purple) or css color (#033 or rgba(255, 0, 0, 0.5)). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-tab/hide-slider": {
"type": "boolean\n",
"description": "Hides the active tab slider component (no exit or enter animation)."
},
"v-tab/stacked": {
"type": "boolean\n",
"description": "Displays the tab as a flex-column."
},
"v-table/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-table/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-table/height": {
"type": "string | number\n",
"description": "Use the height prop to set the height of the table."
},
"v-table/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-table/fixed-header": {
"type": "boolean\n",
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
},
"v-table/fixed-footer": {
"type": "boolean\n",
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
},
"v-table/hover": {
"type": "boolean\n",
"description": "Will add a hover effect to a table's row when the mouse is over it."
},
"v-tabs/symbol": {
"type": "any\n",
"description": "The [Symbol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) used to hook into group functionality for components like [v-btn-toggle](/components/btn-toggle) and [v-bottom-navigation](/components/bottom-navigations/)."
},
"v-tabs/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-tabs/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-tabs/height": {
"type": "string | number\n",
"description": "Sets the height of the tabs bar."
},
"v-tabs/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-tabs/color": {
"type": "string\n",
"description": "Applies specified color to the selected tab - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-tabs/stacked": {
"type": "boolean\n",
"description": "Apply the stacked prop to all children v-tab components."
},
"v-tabs/disabled": {
"type": "boolean\n",
"description": "Puts all children components into a disabled state."
},
"v-tabs/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-tabs/max": {
"type": "number\n",
"description": "Sets a maximum number of selections that can be made."
},
"v-tabs/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-tabs/mobile-breakpoint": {
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
"description": "Sets the designated mobile breakpoint for the component."
},
"v-tabs/grow": {
"type": "boolean\n",
"description": "Force `v-tab`'s to take up all available space."
},
"v-tabs/multiple": {
"type": "boolean\n",
"description": "Allows one to select multiple items."
},
"v-tabs/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-tabs/items": {
"type": "(string | number | Record)[]\n",
"description": "The items to display in the component. This can be an array of strings or objects with a property `title`."
},
"v-tabs/next-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Right pagination icon."
},
"v-tabs/prev-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Left pagination icon."
},
"v-tabs/show-arrows": {
"type": "string | boolean\n",
"description": "Show pagination arrows if the tab items overflow their container. For mobile devices, arrows will only display when using this prop."
},
"v-tabs/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the tabs. Can be either `horizontal` or `vertical`."
},
"v-tabs/align-tabs": {
"type": "'title' | 'end' | 'start' | 'center'\n",
"description": "Aligns the tabs to the `start`, `center`, or `end` of container. Also accepts `title` to align with the `v-toolbar-title` component."
},
"v-tabs/fixed-tabs": {
"type": "boolean\n",
"description": "`v-tabs-item` min-width 160px, max-width 360px."
},
"v-tabs/hide-slider": {
"type": "boolean\n",
"description": "Hide's the generated `v-tabs-slider`."
},
"v-tabs/slider-color": {
"type": "string\n",
"description": "Changes the background color of an auto-generated `v-tabs-slider`."
},
"v-tabs/center-active": {
"type": "boolean\n",
"description": "Forces the selected tab to be centered."
},
"v-text-field/flat": {
"type": "boolean\n",
"description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props."
},
"v-text-field/type": {
"type": "string\n",
"description": "Sets input type."
},
"v-text-field/reverse": {
"type": "boolean\n",
"description": "Reverses the input orientation."
},
"v-text-field/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-text-field/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-text-field/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-text-field/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-text-field/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-text-field/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-text-field/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-text-field/autofocus": {
"type": "boolean\n",
"description": "Enables autofocus."
},
"v-text-field/counter": {
"type": "string | number | boolean\n",
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
},
"v-text-field/prefix": {
"type": "string\n",
"description": "Displays prefix text."
},
"v-text-field/placeholder": {
"type": "string\n",
"description": "Sets the input’s placeholder text."
},
"v-text-field/persistent-placeholder": {
"type": "boolean\n",
"description": "Forces placeholder to always be visible."
},
"v-text-field/persistent-counter": {
"type": "boolean\n",
"description": "Forces counter to always be visible."
},
"v-text-field/suffix": {
"type": "string\n",
"description": "Displays suffix text."
},
"v-text-field/role": {
"type": "string\n",
"description": "The role attribute applied to the input."
},
"v-text-field/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-text-field/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-text-field/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
},
"v-text-field/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-text-field/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-text-field/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-text-field/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-text-field/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-text-field/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-text-field/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-text-field/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-text-field/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-text-field/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-text-field/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-text-field/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-text-field/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-text-field/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-text-field/append-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot."
},
"v-text-field/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-text-field/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared."
},
"v-text-field/clear-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Applied when using **clearable** and the input is dirty."
},
"v-text-field/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-text-field/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-text-field/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-text-field/dirty": {
"type": "boolean\n",
"description": "Manually apply the dirty state styling."
},
"v-text-field/persistent-clear": {
"type": "boolean\n",
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
},
"v-text-field/prepend-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`."
},
"v-text-field/single-line": {
"type": "boolean\n",
"description": "Label does not move on focus/dirty."
},
"v-text-field/variant": {
"type": " | 'underlined'\n | 'outlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-text-field/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-text-field/rounded": {
"type": "string | number | boolean\n",
"description": "Adds a border radius to the input."
},
"v-text-field/counter-value": {
"type": "number | ((value: any) => number)\n",
"description": "Function returns the counter display text."
},
"v-text-field/model-modifiers": {
"type": "unknown\n",
"description": "**FOR INTERNAL USE ONLY**"
},
"v-textarea/flat": {
"type": "boolean\n",
"description": "Removes box shadow when using a variant with elevation."
},
"v-textarea/model-value": {
"type": "any\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-textarea/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-textarea/reverse": {
"type": "boolean\n",
"description": "Reverses the orientation."
},
"v-textarea/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-textarea/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-textarea/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-textarea/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-textarea/variant": {
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
"description": "Applies a distinct style to the component."
},
"v-textarea/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-textarea/active": {
"type": "boolean\n",
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
},
"v-textarea/prepend-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
},
"v-textarea/append-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
},
"v-textarea/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the input."
},
"v-textarea/loading": {
"type": "string | boolean\n",
"description": "Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color."
},
"v-textarea/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-textarea/bg-color": {
"type": "string\n",
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-textarea/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Changes the direction of the input."
},
"v-textarea/base-color": {
"type": "string\n",
"description": "Sets the color of the input when it is not focused."
},
"v-textarea/id": {
"type": "string\n",
"description": "Sets the DOM id on the component."
},
"v-textarea/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-textarea/autofocus": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VTextarea.json))"
},
"v-textarea/counter": {
"type": "string | number | true\n",
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
},
"v-textarea/prefix": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VTextarea.json))"
},
"v-textarea/placeholder": {
"type": "string\n",
"description": "Sets the input's placeholder text."
},
"v-textarea/persistent-placeholder": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VTextarea.json))"
},
"v-textarea/persistent-counter": {
"type": "boolean\n",
"description": "Forces counter to always be visible."
},
"v-textarea/suffix": {
"type": "string\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VTextarea.json))"
},
"v-textarea/center-affix": {
"type": "boolean\n",
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
},
"v-textarea/hide-spin-buttons": {
"type": "boolean\n",
"description": "Hides spin buttons on the input when type is set to `number`."
},
"v-textarea/hint": {
"type": "string\n",
"description": "Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property."
},
"v-textarea/persistent-hint": {
"type": "boolean\n",
"description": "Forces [hint](#props-hint) to always be visible."
},
"v-textarea/messages": {
"type": "string | string[]\n",
"description": "Displays a list of messages or a single message if using a string."
},
"v-textarea/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-textarea/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-textarea/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-textarea/validate-on": {
"type": " | 'lazy'\n | 'input'\n | 'blur'\n | 'submit'\n | 'input lazy'\n | 'blur lazy'\n | 'submit lazy'\n | 'lazy input'\n | 'lazy blur'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-textarea/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-textarea/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-textarea/hide-details": {
"type": "boolean | 'auto'\n",
"description": "Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display."
},
"v-textarea/append-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot."
},
"v-textarea/clearable": {
"type": "boolean\n",
"description": "Allows for the component to be cleared."
},
"v-textarea/clear-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "The icon used when the **clearable** prop is set to true."
},
"v-textarea/dirty": {
"type": "boolean\n",
"description": "Manually apply the dirty state styling."
},
"v-textarea/persistent-clear": {
"type": "boolean\n",
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
},
"v-textarea/prepend-inner-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
},
"v-textarea/single-line": {
"type": "boolean\n",
"description": "Label does not move on focus/dirty."
},
"v-textarea/counter-value": {
"type": "(value: any) => number\n",
"description": "Display the input length but do not provide any validation."
},
"v-textarea/model-modifiers": {
"type": "unknown\n",
"description": "**FOR INTERNAL USE ONLY**"
},
"v-textarea/auto-grow": {
"type": "boolean\n",
"description": "Automatically grow the textarea depending on amount of text."
},
"v-textarea/no-resize": {
"type": "boolean\n",
"description": "Remove resize handle."
},
"v-textarea/rows": {
"type": "string | number\n",
"description": "Default row count."
},
"v-textarea/max-rows": {
"type": "string | number\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VTextarea.json))"
},
"v-theme-provider/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-theme-provider/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-theme-provider/with-background": {
"type": "boolean\n",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree//packages/api-generator/src/locale/en/VThemeProvider.json))"
},
"v-timeline/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-timeline/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-timeline/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "Display timeline in a **vertical** or **horizontal** direction."
},
"v-timeline/density": {
"type": "'default' | 'comfortable' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-timeline/align": {
"type": "'start' | 'center'\n",
"description": "Places the timeline dot at the top or center of the timeline item."
},
"v-timeline/side": {
"type": "'start' | 'end'\n",
"description": "Display all timeline items on one side of the timeline, either **before** or **after**."
},
"v-timeline/justify": {
"type": "string\n",
"description": "Places timeline line at the center or automatically on the left or right side."
},
"v-timeline/line-inset": {
"type": "string | number\n",
"description": "Specifies the distance between the line and the dot of timeline items."
},
"v-timeline/line-thickness": {
"type": "string | number\n",
"description": "Thickness of the timeline line."
},
"v-timeline/line-color": {
"type": "string\n",
"description": "Color of the timeline line."
},
"v-timeline/truncate-line": {
"type": "'start' | 'end' | 'both'\n",
"description": "Truncate timeline directly at the **start** or **end** of the line, or on **both** ends."
},
"v-timeline-item/icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Apply a specific icon to the inside dot using the [v-icon](/components/icons/) component."
},
"v-timeline-item/density": {
"type": "'default' | 'compact'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-timeline-item/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-timeline-item/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-timeline-item/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-timeline-item/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-timeline-item/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-timeline-item/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-timeline-item/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-timeline-item/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-timeline-item/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-timeline-item/size": {
"type": "string | number\n",
"description": "Size of the item dot"
},
"v-timeline-item/dot-color": {
"type": "string\n",
"description": "Color of the item dot."
},
"v-timeline-item/fill-dot": {
"type": "boolean\n",
"description": "Remove outer border of item dot, making the color fill the entire dot."
},
"v-timeline-item/hide-dot": {
"type": "boolean\n",
"description": "Hide the timeline item dot."
},
"v-timeline-item/hide-opposite": {
"type": "boolean\n",
"description": "Hide opposite content if it exists."
},
"v-timeline-item/icon-color": {
"type": "string\n",
"description": "Color of the icon."
},
"v-timeline-item/line-inset": {
"type": "string | number\n",
"description": "Specifies the distance between the line and the dot of the item."
},
"v-toolbar/flat": {
"type": "boolean\n",
"description": "Removes the toolbar's box-shadow."
},
"v-toolbar/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-toolbar/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-toolbar/title": {
"type": "string\n",
"description": "Specify a title text for the component."
},
"v-toolbar/absolute": {
"type": "boolean\n",
"description": "Applies position: absolute to the component."
},
"v-toolbar/height": {
"type": "string | number\n",
"description": "Designates a specific height for the toolbar. Overrides the heights imposed by other props, e.g. **prominent**, **dense**, **extended**, etc."
},
"v-toolbar/density": {
"type": "'default' | 'comfortable' | 'compact' | 'prominent'\n",
"description": "Adjusts the vertical height used by the component."
},
"v-toolbar/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-toolbar/rounded": {
"type": "string | number | boolean\n",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius)."
},
"v-toolbar/border": {
"type": "string | number | boolean\n",
"description": "Applies border styles to component."
},
"v-toolbar/elevation": {
"type": "string | number\n",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
},
"v-toolbar/floating": {
"type": "boolean\n",
"description": "Applies **display: inline-flex** to the component."
},
"v-toolbar/image": {
"type": "string\n",
"description": "Specifies a [v-img](/components/images) as the component's background."
},
"v-toolbar/collapse": {
"type": "boolean\n",
"description": "Puts the toolbar into a collapsed state reducing its maximum width."
},
"v-toolbar/extended": {
"type": "boolean\n",
"description": "Use this prop to increase the height of the toolbar _without_ using the `extension` slot for adding content. May be used in conjunction with the **extension-height** prop, and any of the other props that affect the height of the toolbar, e.g. **prominent**, **dense**, etc., **WITH THE EXCEPTION** of **height**."
},
"v-toolbar/extension-height": {
"type": "string | number\n",
"description": "Specify an explicit height for the `extension` slot."
},
"v-toolbar-items/color": {
"type": "string\n",
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
},
"v-toolbar-items/variant": {
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
"description": "Applies a distinct style to the component."
},
"v-toolbar-title/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-toolbar-title/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-tooltip/text": {
"type": "string\n",
"description": "Specify content text for the component."
},
"v-tooltip/model-value": {
"type": "boolean\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-tooltip/height": {
"type": "string | number\n",
"description": "Sets the height for the component."
},
"v-tooltip/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-tooltip/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-tooltip/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-tooltip/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-tooltip/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-tooltip/location": {
"type": "Anchor\n",
"description": "Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both.."
},
"v-tooltip/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-tooltip/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-tooltip/transition": {
"type": "string | boolean | (TransitionProps & { component: Component })\n",
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-tooltip/activator": {
"type": "(string & {}) | Element | 'parent' | ComponentPublicInstance\n",
"description": "Explicitly sets the overlay's activator."
},
"v-tooltip/close-on-back": {
"type": "boolean\n",
"description": "Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing."
},
"v-tooltip/contained": {
"type": "boolean\n",
"description": "Limits the size of the component and scrim to its offset parent. Implies `absolute` and `attach`. (Note: The parent element must have position: relative.)."
},
"v-tooltip/content-class": {
"type": "any\n",
"description": "Applies a custom class to the detached element. This is useful because the content is moved to the beginning of the `v-app` component (unless the **attach** prop is provided) and is not targetable by classes passed directly on the component."
},
"v-tooltip/content-props": {
"type": "any\n",
"description": "Apply custom properties to the content."
},
"v-tooltip/no-click-animation": {
"type": "boolean\n",
"description": "Disables the bounce effect when clicking outside of the content element when using the persistent prop."
},
"v-tooltip/scrim": {
"type": "string | boolean\n",
"description": "Accepts true/false to enable background, and string to define color."
},
"v-tooltip/z-index": {
"type": "string | number\n",
"description": "The z-index used for the component."
},
"v-tooltip/target": {
"type": " | (string & {})\n | Element\n | 'parent'\n | 'cursor'\n | ComponentPublicInstance\n | [number, number]\n",
"description": "For locationStrategy=\"connected\", specify an element or array of x,y coordinates that the overlay should position itself relative to. This will be the activator element by default."
},
"v-tooltip/activator-props": {
"type": "unknown\n",
"description": "Apply custom properties to the activator."
},
"v-tooltip/open-on-click": {
"type": "boolean\n",
"description": "Designates whether the tooltip should open on activator click."
},
"v-tooltip/open-on-hover": {
"type": "boolean\n",
"description": "Designates whether the tooltip should open on activator hover."
},
"v-tooltip/open-on-focus": {
"type": "boolean\n",
"description": "Activate the component when the activator is focused."
},
"v-tooltip/close-on-content-click": {
"type": "boolean\n",
"description": "Closes component when you click on its content."
},
"v-tooltip/close-delay": {
"type": "string | number\n",
"description": "Delay (in ms) after which menu closes (when open-on-hover prop is set to true)."
},
"v-tooltip/open-delay": {
"type": "string | number\n",
"description": "Delay (in ms) after which tooltip opens (when `open-on-hover` prop is set to **true**)."
},
"v-tooltip/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-tooltip/location-strategy": {
"type": "'static' | 'connected' | LocationStrategyFn\n",
"description": "A function used to specifies how the component should position relative to its activator."
},
"v-tooltip/origin": {
"type": "Anchor | 'auto' | 'overlap'\n",
"description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin)."
},
"v-tooltip/offset": {
"type": "string | number | number[]\n",
"description": "A single value that offsets content away from the target based upon what side it is on."
},
"v-tooltip/scroll-strategy": {
"type": "'close' | 'block' | 'none' | 'reposition' | ScrollStrategyFn\n",
"description": "Strategy used when the component is activate and user scrolls."
},
"v-tooltip/attach": {
"type": "string | boolean | Element\n",
"description": "Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default."
},
"v-tooltip/id": {
"type": "string\n",
"description": "HTML id attribute of the tooltip overlay. If not set, a globally unique id will be used."
},
"v-validation/name": {
"type": "string\n",
"description": "Sets the component's name attribute."
},
"v-validation/error": {
"type": "boolean\n",
"description": "Puts the input in a manual error state."
},
"v-validation/label": {
"type": "string\n",
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
},
"v-validation/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-validation/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-validation/error-messages": {
"type": "string | string[]\n",
"description": "Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation."
},
"v-validation/max-errors": {
"type": "string | number\n",
"description": "Control the maximum number of shown errors from validation."
},
"v-validation/readonly": {
"type": "boolean\n",
"description": "Puts input in readonly state."
},
"v-validation/rules": {
"type": "ValidationRule[]\n",
"description": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`."
},
"v-validation/validate-on": {
"type": " | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n",
"description": "Change what type of event triggers validation to run."
},
"v-validation/validation-value": {
"type": "any\n",
"description": "The value used when applying validation rules."
},
"v-validation/focused": {
"type": "boolean\n",
"description": "Forces a focused state styling on the component."
},
"v-virtual-scroll/items": {
"type": "unknown[]\n",
"description": "The array of items to display."
},
"v-virtual-scroll/height": {
"type": "string | number\n",
"description": "Height of the component as a css value/"
},
"v-virtual-scroll/max-height": {
"type": "string | number\n",
"description": "Sets the maximum height for the component."
},
"v-virtual-scroll/max-width": {
"type": "string | number\n",
"description": "Sets the maximum width for the component."
},
"v-virtual-scroll/min-height": {
"type": "string | number\n",
"description": "Sets the minimum height for the component."
},
"v-virtual-scroll/min-width": {
"type": "string | number\n",
"description": "Sets the minimum width for the component."
},
"v-virtual-scroll/width": {
"type": "string | number\n",
"description": "Sets the width for the component."
},
"v-virtual-scroll/item-height": {
"type": "string | number\n",
"description": "Height in pixels of each item to display."
},
"v-virtual-scroll/renderless": {
"type": "boolean\n",
"description": "Disables default component rendering functionality."
},
"v-window/tag": {
"type": "string\n",
"description": "Specify a custom tag used on the root element."
},
"v-window/reverse": {
"type": "boolean\n",
"description": "Reverse the normal transition direction."
},
"v-window/theme": {
"type": "string\n",
"description": "Specify a theme for this component and all of its children."
},
"v-window/disabled": {
"type": "boolean\n",
"description": "Removes the ability to click or target the component."
},
"v-window/model-value": {
"type": "unknown\n",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
},
"v-window/direction": {
"type": "'horizontal' | 'vertical'\n",
"description": "The transition direction when changing windows."
},
"v-window/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-window/mandatory": {
"type": "boolean | 'force'\n",
"description": "Forces at least one item to always be selected (if available)."
},
"v-window/prev-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for the \"prev\" button if `show-arrows` is `true`."
},
"v-window/next-icon": {
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
"description": "Icon used for the \"next\" button if `show-arrows` is `true`."
},
"v-window/show-arrows": {
"type": "string | boolean\n",
"description": "Display the \"next\" and \"prev\" buttons."
},
"v-window/continuous": {
"type": "boolean\n",
"description": "If `true`, window will \"wrap around\" from the last item to the first, and from the first item to the last."
},
"v-window/touch": {
"type": "boolean | TouchHandlers\n",
"description": "Provide a custom **left** and **right** function when swiped left or right."
},
"v-window-item/value": {
"type": "any\n",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
},
"v-window-item/disabled": {
"type": "boolean\n",
"description": "Prevents the item from becoming active when using the \"next\" and \"prev\" buttons or the `toggle` method."
},
"v-window-item/selected-class": {
"type": "string\n",
"description": "Configure the active CSS class applied when an item is selected."
},
"v-window-item/transition": {
"type": "string | boolean\n",
"description": "The transition used when the component progressing through items. Can be one of the [built in](/styles/transitions/) or custom transition."
},
"v-window-item/eager": {
"type": "boolean\n",
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
},
"v-window-item/reverse-transition": {
"type": "string | boolean\n",
"description": "Sets the reverse transition."
}
}