UNPKG

vuetify

Version:

Vue Material Component Framework

1,059 lines 402 kB
{ "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/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/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/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": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array" }, "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": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\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": "MISSING DESCRIPTION" }, "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/theme": { "type": "string\n", "description": "Specify a theme for this component and all of its children" }, "v-app/full-height": { "type": "boolean\n", "description": "Sets the component height to 100%" }, "v-app/overlaps": { "type": "string[]\n", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/layout.json))" }, "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/scroll-behavior": { "type": "string\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/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-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." }, "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": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\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": "MISSING DESCRIPTION" }, "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/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/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-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/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/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/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** prop](https://router.vuejs.org/api/#replace) on the vue-router documentation." }, "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": "unknown\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-title/text": { "type": "string\n", "description": "Specify content text for the component." }, "v-app-bar-title/tag": { "type": "string\n", "description": "Specify a custom tag used on the root element." }, "v-autocomplete/flat": { "type": "boolean\n", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props" }, "v-autocomplete/type": { "type": "string\n", "description": "Sets input type" }, "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/error": { "type": "boolean\n", "description": "Puts the input in a manual error state" }, "v-autocomplete/density": { "type": "'default' | 'comfortable' | 'compact'\n", "description": "Adjusts the vertical height used by the component." }, "v-autocomplete/reverse": { "type": "boolean\n", "description": "Reverses the orientation " }, "v-autocomplete/rounded": { "type": "string | number | boolean\n", "description": "Adds a border radius to the input" }, "v-autocomplete/theme": { "type": "string\n", "description": "Specify a theme for this component and all of its children" }, "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/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-autocomplete/name": { "type": "string\n", "description": "Sets the component's name attribute." }, "v-autocomplete/id": { "type": "string\n", "description": "Sets the DOM id on the component" }, "v-autocomplete/items": { "type": "any[]\n", "description": "An array of strings or objects used for automatically generating children components" }, "v-autocomplete/active": { "type": "boolean\n", "description": "Controls the **active** state of the item. This is typically used to highlight the component" }, "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/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/disabled": { "type": "boolean\n", "description": "Removes the ability to click or target the input" }, "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/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/search": { "type": "string\n", "description": "Text input used to filter items." }, "v-autocomplete/filter-mode": { "type": "'every' | 'some' | 'union' | 'intersection'\n", "description": "Apply a specific filter when matching items. **some** is the default, which will return true if any key matches the search term. **every** will return true only if every key matches the search term. The **union** mode will return true if every key matches the search term. The **intersection** mode will return true if any key matches the search term." }, "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": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a>\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": "{ [string]: <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a> }\n", "description": "Function used on specific keys within the item object." }, "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": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/select.json))" }, "v-autocomplete/closable-chips": { "type": "boolean\n", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/select.json))" }, "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": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/select.json))" }, "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": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/select.json))" }, "v-autocomplete/transition": { "type": "string | boolean\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": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/select.json))" }, "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": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/select.json))" }, "v-autocomplete/value-comparator": { "type": "(a: any, b: any) => boolean\n", "description": "Apply a custom comparison algorithm used for values" }, "v-autocomplete/item-title": { "type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L71-L75\" target=\"_blank\">SelectItemKey</a>\n", "description": "Property on supplied `items` that contains its title" }, "v-autocomplete/item-value": { "type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L71-L75\" target=\"_blank\">SelectItemKey</a>\n", "description": "Property on supplied `items` that contains its value" }, "v-autocomplete/item-children": { "type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L71-L75\" target=\"_blank\">SelectItemKey</a>\n", "description": "Property on supplied `items` that contains its children" }, "v-autocomplete/item-props": { "type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L71-L75\" target=\"_blank\">SelectItemKey</a>\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/autofocus": { "type": "boolean\n", "description": "Enables autofocus" }, "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/center-affix": { "type": "boolean\n", "description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center" }, "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/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": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/validation.ts#L16-L20\" target=\"_blank\">ValidationRule</a>[]\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 **clerable** prop is set to true" }, "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/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-autocomplete/counter-value": { "type": "(value: any) => number\n", "description": "Function returns the counter display text" }, "v-autocomplete/model-modifiers": { "type": "Record<string, boolean>\n", "description": "**FOR INTERNAL USE ONLY**" }, "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/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-avatar/image": { "type": "string\n", "description": "Apply a specific image using [v-img](/components/images/)." }, "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": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\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/label": { "type": "string\n", "description": "The **aria-label** used for the badge" }, "v-badge/transition": { "type": "string\n", "description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition." }, "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/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-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": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\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": "MISSING DESCRIPTION" }, "v-banner/sticky": { "type": "boolean\n", "description": "Applies **position: sticky** to the component (**Evergreen browsers only**). 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 only applicable when the banner is not **single-line** or using the **actions** slot." }, "v-banner/avatar": { "type": "string\n", "description": "Designates a specific src image to pass to the thumbnail." }, "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": "any\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/multiple": { "type": "boolean\n", "description": "Allows one to select mulitple items." }, "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/mode": { "type": "string\n", "description": "Changes the orientation and active state styling of the component." }, "v-bottom-navigation/max": { "type": "number\n", "description": "Sets a maximum number of selections that can be made." }, "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/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": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n", "description": "MISSING DESCRIPTION" }, "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/z-index": { "type": "string | number\n", "description": "The z-index used for the component" }, "v-bottom-sheet/disabled": { "type": "boolean\n", "description": "Removes the ability to click or target the component" }, "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/activator": { "type": "string | Element | ComponentPublicInstance\n", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-overlay-activator.json))" }, "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`." }, "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": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-overlay.json))" }, "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/activator-props": { "type": "{}\n", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-overlay-activator.json))" }, "v-bottom-sheet/open-on-click": { "type": "boolean\n", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-overlay-activator.json))" }, "v-bottom-sheet/open-on-hover": { "type": "boolean\n", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-overlay-activator.json))" }, "v-bottom-sheet/open-on-focus": { "type": "boolean\n", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-overlay-activator.json))" }, "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/location-strategy": { "type": "'static' | 'connected' | <a href=\"https://github.com/vuetifyjs/vuetify