UNPKG

vuetify

Version:

Vue Material Component Framework

984 lines 438 kB
{ "v-app/full-height": { "type": "boolean", "description": "Sets the component height to 100%" }, "v-app/overlaps": { "type": "string[]", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/layout.json))" }, "v-app/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-app/$slots": { "type": "{ default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-app-bar/flat": { "type": "boolean", "description": "Removes the component's **box-shadow**." }, "v-app-bar/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-app-bar/name": { "type": "string", "description": "Assign a specific name for layout registration." }, "v-app-bar/$slots": { "type": "{ default: (args: []) => VNodeChild; image: (args: []) => VNodeChild; prepend: (args: []) => VNodeChild; append: (args: []) => VNodeChild; title: (args: []) => VNodeChild; extension: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-app-bar/image": { "type": "string", "description": "Specifies a [v-img](/components/images) as the component's background." }, "v-app-bar/title": { "type": "string", "description": "Specify a title text for the component." }, "v-app-bar/model-value": { "type": "boolean", "description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array" }, "v-app-bar/location": { "type": "\"top\" | \"bottom\"", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-app-bar.json))" }, "v-app-bar/absolute": { "type": "boolean", "description": "Applies position: absolute to the component." }, "v-app-bar/collapse": { "type": "boolean", "description": "Morphs the component into a collapsed state, reducing its maximum width." }, "v-app-bar/color": { "type": "string", "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/density": { "type": "\"default\" | \"prominent\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-app-bar/extended": { "type": "boolean", "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", "description": "Designate an explicit height for the `extension` slot." }, "v-app-bar/floating": { "type": "boolean", "description": "Applies **display: inline-flex** to the component." }, "v-app-bar/height": { "type": "string | number", "description": "Designates a specific height for the toolbar. Overrides the heights imposed by other props, e.g. **prominent**, **dense**, **extended**, etc." }, "v-app-bar/border": { "type": "string | number | boolean", "description": "Applies border styles to component." }, "v-app-bar/elevation": { "type": "string | number", "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/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-app-bar/order": { "type": "string | number", "description": "Adjust the order of the component in relation to its registration order." }, "v-app-bar-nav-icon/$slots": { "type": "{ default: (args: []) => VNodeChild; prepend: (args: []) => VNodeChild; append: (args: []) => VNodeChild; loader: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-app-bar-nav-icon/icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Apply a specific icon using the [v-icon](/components/icons/) component." }, "v-app-bar-title/$slots": { "type": "{ default: (args: []) => VNodeChild; text: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-app-bar-title/tag": { "type": "string", "description": "Specify a custom tag used on the root element." }, "v-app-bar-title/text": { "type": "string", "description": "Specify content text for the component." }, "v-alert/type": { "type": "\"success\" | \"warning\" | \"error\" | \"info\"", "description": "Create a specialized alert that uses a contextual color and has a pre-defined icon." }, "v-alert/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-alert/$slots": { "type": "{ default: (args: []) => VNodeChild; prepend: (args: []) => VNodeChild; title: (args: []) => VNodeChild; text: (args: []) => VNodeChild; append: (args: []) => VNodeChild; close: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-alert/position": { "type": "\"relative\" | \"absolute\" | \"static\" | \"fixed\" | \"sticky\"", "description": "Specifies the type of positioning method used for the component." }, "v-alert/title": { "type": "string", "description": "Specify a title text for the component." }, "v-alert/model-value": { "type": "boolean", "description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array" }, "v-alert/location": { "type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L7-L13\" target=\"_blank\">Anchor</a>", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/location.json))" }, "v-alert/color": { "type": "string", "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/density": { "type": "\"default\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-alert/prominent": { "type": "boolean", "description": "Displays a larger vertically centered icon to draw more attention." }, "v-alert/height": { "type": "string | number", "description": "Sets the height for the component." }, "v-alert/border": { "type": "boolean | \"top\" | \"bottom\" | \"end\" | \"start\"", "description": "Adds a colored border to the component." }, "v-alert/elevation": { "type": "string | number", "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/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-alert/icon": { "type": "false | string | (new () => any) | FunctionalComponent", "description": "Apply a specific icon using the [v-icon](/components/icons/) component." }, "v-alert/text": { "type": "string", "description": "Specify content text for the component." }, "v-alert/border-color": { "type": "string", "description": "Specifies the color of the border. Accepts any color value." }, "v-alert/closable": { "type": "boolean", "description": "Adds a close icon that can hide the alert." }, "v-alert/close-icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Change the default icon used for **closable** alerts." }, "v-alert/close-label": { "type": "string", "description": "Text used for *aria-label* on **closable** alerts. Can also be customized globally in [Internationalization](/customization/internationalization)." }, "v-alert/max-height": { "type": "string | number", "description": "Sets the maximum height for the component." }, "v-alert/max-width": { "type": "string | number", "description": "Sets the maximum width for the component." }, "v-alert/min-height": { "type": "string | number", "description": "Sets the minimum height for the component." }, "v-alert/min-width": { "type": "string | number", "description": "Sets the minimum width for the component." }, "v-alert/width": { "type": "string | number", "description": "Sets the width for the component." }, "v-alert/variant": { "type": "\"flat\" | \"text\" | \"elevated\" | \"tonal\" | \"outlined\" | \"plain\"", "description": "Applies a distinct style to the component" }, "v-alert-title/$slots": { "type": "{ default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-alert-title/tag": { "type": "string", "description": "Specify a custom tag used on the root element" }, "v-autocomplete/type": { "type": "string", "description": "Sets input type" }, "v-autocomplete/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-autocomplete/name": { "type": "string", "description": "Sets the component's name attribute." }, "v-autocomplete/reverse": { "type": "boolean", "description": "Reverses the input orientation" }, "v-autocomplete/$slots": { "type": "{ prepend: (args: [{ id: ComputedRef<string>; messagesId: ComputedRef<string>; isDirty: ComputedRef<boolean>; isDisabled: ComputedRef<boolean>; isReadonly: ComputedRef<boolean>; isPristine: Ref<boolean>; isValid: ComputedRef<boolean>; isValidating: Ref<boolean>; reset: () => void; resetValidation: () => void; validate: () => void }]) => VNodeChild; append: (args: [{ id: ComputedRef<string>; messagesId: ComputedRef<string>; isDirty: ComputedRef<boolean>; isDisabled: ComputedRef<boolean>; isReadonly: ComputedRef<boolean>; isPristine: Ref<boolean>; isValid: ComputedRef<boolean>; isValidating: Ref<boolean>; reset: () => void; resetValidation: () => void; validate: () => void }]) => VNodeChild; loader: (args: [{ color: string; isActive: boolean }]) => VNodeChild; details: (args: [{ id: ComputedRef<string>; messagesId: ComputedRef<string>; isDirty: ComputedRef<boolean>; isDisabled: ComputedRef<boolean>; isReadonly: ComputedRef<boolean>; isPristine: Ref<boolean>; isValid: ComputedRef<boolean>; isValidating: Ref<boolean>; reset: () => void; resetValidation: () => void; validate: () => void }]) => VNodeChild; clear: (args: []) => VNodeChild; prepend-inner: (args: [({ isActive: Ref<boolean>; isFocused: Ref<boolean>; controlRef: Ref<HTMLElement>; focus: () => void; blur: () => void } & { id: ComputedRef<string>; messagesId: ComputedRef<string>; isDirty: ComputedRef<boolean>; isDisabled: ComputedRef<boolean>; isReadonly: ComputedRef<boolean>; isPristine: Ref<boolean>; isValid: ComputedRef<boolean>; isValidating: Ref<boolean>; reset: () => void; resetValidation: () => void; validate: () => void })]) => VNodeChild; append-inner: (args: [({ isActive: Ref<boolean>; isFocused: Ref<boolean>; controlRef: Ref<HTMLElement>; focus: () => void; blur: () => void } & { id: ComputedRef<string>; messagesId: ComputedRef<string>; isDirty: ComputedRef<boolean>; isDisabled: ComputedRef<boolean>; isReadonly: ComputedRef<boolean>; isPristine: Ref<boolean>; isValid: ComputedRef<boolean>; isValidating: Ref<boolean>; reset: () => void; resetValidation: () => void; validate: () => void })]) => VNodeChild; label: (args: [({ isActive: Ref<boolean>; isFocused: Ref<boolean>; controlRef: Ref<HTMLElement>; focus: () => void; blur: () => void } & { id: ComputedRef<string>; messagesId: ComputedRef<string>; isDirty: ComputedRef<boolean>; isDisabled: ComputedRef<boolean>; isReadonly: ComputedRef<boolean>; isPristine: Ref<boolean>; isValid: ComputedRef<boolean>; isValidating: Ref<boolean>; reset: () => void; resetValidation: () => void; validate: () => void })]) => VNodeChild; item: (args: [{ item: { title: string; value: any; props: { title: string; value: any; [string]: any }; children: InternalItem<unknown>[]; raw: unknown }; index: number; props: Record<string, unknown> }]) => VNodeChild; chip: (args: [{ item: { title: string; value: any; props: { title: string; value: any; [string]: any }; children: InternalItem<unknown>[]; raw: unknown }; index: number; props: Record<string, unknown> }]) => VNodeChild; selection: (args: [{ item: { title: string; value: any; props: { title: string; value: any; [string]: any }; children: InternalItem<unknown>[]; raw: unknown }; index: number }]) => VNodeChild; prepend-item: (args: []) => VNodeChild; append-item: (args: []) => VNodeChild; no-data: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-autocomplete/id": { "type": "string", "description": "Sets the DOM id on the component" }, "v-autocomplete/items": { "type": "unknown[]", "description": "Can be an array of objects or array of strings. When using objects, will look for a title, value and disabled keys. This can be changed using the **item-title**, **item-value** and **item-disabled** props. Objects that have a **header** or **divider** property are considered special cases and generate a list header or divider; these items are not selectable." }, "v-autocomplete/error": { "type": "boolean", "description": "Puts the input in a manual error state" }, "v-autocomplete/model-value": { "type": "any", "description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array" }, "v-autocomplete/color": { "type": "string", "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/density": { "type": "\"default\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-autocomplete/variant": { "type": "\"outlined\" | \"plain\" | \"underlined\" | \"filled\" | \"solo\"", "description": "Applies a distinct style to the component" }, "v-autocomplete/search": { "type": "string", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-autocomplete.json))" }, "v-autocomplete/label": { "type": "string", "description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component" }, "v-autocomplete/filter-mode": { "type": "\"every\" | \"some\" | \"union\" | \"intersection\"", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/filter.json))" }, "v-autocomplete/no-filter": { "type": "boolean", "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#L20-L20\" target=\"_blank\">FilterFunction</a>", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/filter.json))" }, "v-autocomplete/custom-key-filter": { "type": "{ [string]: <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L20-L20\" target=\"_blank\">FilterFunction</a> }", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/filter.json))" }, "v-autocomplete/filter-keys": { "type": "string | string[]", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/filter.json))" }, "v-autocomplete/chips": { "type": "boolean", "description": "Changes display of selections to chips" }, "v-autocomplete/closable-chips": { "type": "boolean", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-select.json))" }, "v-autocomplete/eager": { "type": "boolean", "description": "MISSING DESCRIPTION" }, "v-autocomplete/hide-no-data": { "type": "boolean", "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", "description": "Do not display in the select menu items that are already selected" }, "v-autocomplete/menu": { "type": "boolean", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-select.json))" }, "v-autocomplete/menu-icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-select.json))" }, "v-autocomplete/menu-props": { "type": "unknown", "description": "Pass props through to the `v-menu` component. Accepts an object with anything from [/api/v-menu](/api/v-menu/#props), camelCase keys are recommended." }, "v-autocomplete/disabled": { "type": "boolean", "description": "Removes the ability to click or target the input" }, "v-autocomplete/transition": { "type": "string | boolean", "description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition." }, "v-autocomplete/multiple": { "type": "boolean", "description": "Changes select to multiple. Accepts array for value" }, "v-autocomplete/no-data-text": { "type": "string", "description": "Text shown when no items are provided to the component" }, "v-autocomplete/open-on-clear": { "type": "boolean", "description": "When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state" }, "v-autocomplete/value-comparator": { "type": "(a: any, b: any) => boolean", "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>", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/item.json))" }, "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>", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/item.json))" }, "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>", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/item.json))" }, "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>", "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", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/item.json))" }, "v-autocomplete/autofocus": { "type": "boolean", "description": "Enables autofocus" }, "v-autocomplete/hint": { "type": "string", "description": "Hint text" }, "v-autocomplete/persistent-hint": { "type": "boolean", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-text-field.json))" }, "v-autocomplete/prefix": { "type": "string", "description": "Displays prefix text" }, "v-autocomplete/placeholder": { "type": "string", "description": "Sets the input’s placeholder text" }, "v-autocomplete/persistent-placeholder": { "type": "boolean", "description": "Forces placeholder to always be visible" }, "v-autocomplete/persistent-counter": { "type": "boolean", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-text-field.json))" }, "v-autocomplete/suffix": { "type": "string", "description": "Displays suffix text" }, "v-autocomplete/append-icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot" }, "v-autocomplete/prepend-icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`" }, "v-autocomplete/messages": { "type": "string | string[]", "description": "Displays a list of messages or message if using a string" }, "v-autocomplete/direction": { "type": "\"horizontal\" | \"vertical\"", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-input.json))" }, "v-autocomplete/error-messages": { "type": "string | string[]", "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", "description": "Control the maximum number of shown errors from validation." }, "v-autocomplete/readonly": { "type": "boolean", "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>[]", "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": "\"blur\" | \"input\" | \"submit\"", "description": "Change what type of event triggers validation to run." }, "v-autocomplete/focused": { "type": "boolean", "description": "Forces a focused state styling on the component." }, "v-autocomplete/hide-details": { "type": "boolean | \"auto\"", "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", "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", "description": "Allows for the component to be cleared" }, "v-autocomplete/clear-icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Applied when using **clearable** and the input is dirty" }, "v-autocomplete/active": { "type": "boolean", "description": "Controls the **active** state of the item. This is typically used to highlight the component" }, "v-autocomplete/persistent-clear": { "type": "boolean", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-field.json))" }, "v-autocomplete/prepend-inner-icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`" }, "v-autocomplete/single-line": { "type": "boolean", "description": "Label does not move on focus/dirty" }, "v-autocomplete/loading": { "type": "string | boolean", "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/counter": { "type": "string | number | true", "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", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-text-field.json))" }, "v-avatar/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-avatar/$slots": { "type": "{ default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-avatar/size": { "type": "string | number", "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", "description": "Apply a specific image using [v-img](/components/images/)." }, "v-avatar/color": { "type": "string", "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/density": { "type": "\"default\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-avatar/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-avatar/icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Apply a specific icon using the [v-icon](/components/icons/) component." }, "v-avatar/end": { "type": "boolean", "description": "Applies margin at the start of the component." }, "v-avatar/start": { "type": "boolean", "description": "Applies margin at the end of the component." }, "v-avatar/variant": { "type": "\"flat\" | \"text\" | \"elevated\" | \"tonal\" | \"outlined\" | \"plain\"", "description": "Applies a distinct style to the component" }, "v-badge/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-badge/$slots": { "type": "{ default: (args: []) => VNodeChild; badge: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-badge/model-value": { "type": "boolean", "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#L7-L13\" target=\"_blank\">Anchor</a>", "description": "Changes the location of the badge. Possible values are **top**, **bottom**, **start**, **end**, **top start**, **top end**, **bottom start**, **bottom end**." }, "v-badge/color": { "type": "string", "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", "description": "Elevates the badge above the slotted content." }, "v-badge/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-badge/icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Apply a specific icon using the [v-icon](/components/icons/) component." }, "v-badge/label": { "type": "string", "description": "The **aria-label** used for the badge" }, "v-badge/transition": { "type": "string", "description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition." }, "v-badge/bordered": { "type": "boolean", "description": "Applies a **2px** by default and **1.5px** border around the badge when using the **dot** property." }, "v-badge/dot": { "type": "boolean", "description": "Reduce the size of the badge and hide its contents." }, "v-badge/inline": { "type": "boolean", "description": "Moves the badge to be inline with the wrapping element. Supports the usage of the **left** prop." }, "v-badge/text-color": { "type": "string", "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/content": { "type": "string | number", "description": "Text content to show in the badge." }, "v-badge/max": { "type": "string | number", "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", "description": "Offset the badge on the x-axis." }, "v-badge/offset-y": { "type": "string | number", "description": "Offset the badge on the y-axis." }, "v-banner/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-banner/$slots": { "type": "{ default: (args: []) => VNodeChild; prepend: (args: []) => VNodeChild; text: (args: []) => VNodeChild; actions: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-banner/position": { "type": "\"relative\" | \"absolute\" | \"static\" | \"fixed\" | \"sticky\"", "description": "Specifies the type of positioning method used for the component." }, "v-banner/location": { "type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L7-L13\" target=\"_blank\">Anchor</a>", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/location.json))" }, "v-banner/color": { "type": "string", "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/density": { "type": "\"default\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-banner/height": { "type": "string | number", "description": "Sets the height for the component." }, "v-banner/border": { "type": "string | number | boolean", "description": "Applies border styles to component." }, "v-banner/elevation": { "type": "string | number", "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/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-banner/icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Apply a specific icon using the [v-icon](/components/icons/) component." }, "v-banner/text": { "type": "string", "description": "Specify content text for the component." }, "v-banner/max-height": { "type": "string | number", "description": "Sets the maximum height for the component." }, "v-banner/max-width": { "type": "string | number", "description": "Sets the maximum width for the component." }, "v-banner/min-height": { "type": "string | number", "description": "Sets the minimum height for the component." }, "v-banner/min-width": { "type": "string | number", "description": "Sets the minimum width for the component." }, "v-banner/width": { "type": "string | number", "description": "Sets the width for the component." }, "v-banner/sticky": { "type": "boolean", "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/avatar": { "type": "string", "description": "Designates a specific src image to pass to the thumbnail." }, "v-banner/stacked": { "type": "boolean", "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/lines": { "type": "\"one\" | \"two\" | \"three\"", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/v-banner.json))" }, "v-banner-actions/$slots": { "type": "{ default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-banner-actions/color": { "type": "string", "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-actions/density": { "type": "string", "description": "Adjusts the vertical height used by the component." }, "v-banner-text/$slots": { "type": "{ default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-banner-text/tag": { "type": "string", "description": "Specify a custom tag used on the root element" }, "v-bottom-navigation/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-bottom-navigation/name": { "type": "string", "description": "Assign a specific name for layout registration." }, "v-bottom-navigation/$slots": { "type": "{ default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-bottom-navigation/model-value": { "type": "any", "description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array" }, "v-bottom-navigation/absolute": { "type": "boolean", "description": "Applies **position: absolute** to the component." }, "v-bottom-navigation/color": { "type": "string", "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/density": { "type": "\"default\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-bottom-navigation/height": { "type": "string | number", "description": "Sets the height for the component" }, "v-bottom-navigation/border": { "type": "string | number | boolean", "description": "Applies border styles to component." }, "v-bottom-navigation/elevation": { "type": "string | number", "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/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-bottom-navigation/order": { "type": "string | number", "description": "Adjust the order of the component in relation to its registration order." }, "v-bottom-navigation/disabled": { "type": "boolean", "description": "Puts all children components into a disabled state" }, "v-bottom-navigation/multiple": { "type": "boolean", "description": "Allows one to select mulitple items." }, "v-bottom-navigation/bg-color": { "type": "string", "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/active": { "type": "boolean", "description": "Controls the **active** state of the item. This is typically used to highlight the component" }, "v-bottom-navigation/mode": { "type": "string", "description": "Changes the orientation and active state styling of the component." }, "v-bottom-navigation/max": { "type": "number", "description": "Sets a maximum number of selections that can be made." }, "v-bottom-navigation/grow": { "type": "boolean", "description": "Force all [v-btn](/components/buttons) children to take up all available horizontal space." }, "v-bottom-navigation/selected-class": { "type": "string", "description": "Configure the active CSS class applied when an item is selected." }, "v-bottom-navigation/mandatory": { "type": "boolean | \"force\"", "description": "Forces at least one item to always be selected (if available)." }, "v-breadcrumbs/$slots": { "type": "{ prepend: (args: []) => VNodeChild; title: (args: [{ item: unknown; index: number }]) => VNodeChild; divider: (args: [{ item: unknown; index: number }]) => VNodeChild; default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-breadcrumbs/items": { "type": "unknown[]", "description": "An array of strings or objects used for automatically generating children components" }, "v-breadcrumbs/color": { "type": "string", "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/density": { "type": "\"default\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-breadcrumbs/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-breadcrumbs/icon": { "type": "string | (new () => any) | FunctionalComponent", "description": "Apply a specific icon using the [v-icon](/components/icons/) component." }, "v-breadcrumbs/disabled": { "type": "boolean", "description": "Removes the ability to click or target the component" }, "v-breadcrumbs/bg-color": { "type": "string", "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", "description": "Specifies the dividing character between items." }, "v-breadcrumbs/active-class": { "type": "string", "description": "The class applied to the component when it is in an active state" }, "v-breadcrumbs/active-color": { "type": "string", "description": "The applied color when the component is in an active state" }, "v-breadcrumbs-item/$slots": { "type": "{ default: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-breadcrumbs-item/title": { "type": "string", "description": "Specify a title text for the component." }, "v-breadcrumbs-item/color": { "type": "string", "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/tag": { "type": "string", "description": "Specify a custom tag used on the root element." }, "v-breadcrumbs-item/replace": { "type": "boolean", "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-breadcrumbs-item/disabled": { "type": "boolean", "description": "Removes the ability to click or target the component" }, "v-breadcrumbs-item/active": { "type": "boolean", "description": "Controls the **active** state of the item. This is typically used to highlight the component" }, "v-breadcrumbs-item/active-class": { "type": "string", "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", "description": "The applied color when the component is in an active state" }, "v-breadcrumbs-item/href": { "type": "string", "description": "Designates the component as anchor and applies the **href** attribute." }, "v-breadcrumbs-item/exact": { "type": "boolean", "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/to": { "type": "unknown", "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", "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/flat": { "type": "boolean", "description": "Removes the button box shadow." }, "v-btn/theme": { "type": "string", "description": "Specify a theme for this component and all of its children" }, "v-btn/$slots": { "type": "{ default: (args: []) => VNodeChild; prepend: (args: []) => VNodeChild; append: (args: []) => VNodeChild; loader: (args: []) => VNodeChild }", "description": "MISSING DESCRIPTION" }, "v-btn/value": { "type": "any", "description": "The value used when the component is selected in a group. If not provided, a unique ID will be used." }, "v-btn/position": { "type": "\"relative\" | \"absolute\" | \"static\" | \"fixed\" | \"sticky\"", "description": "Specifies the type of positioning method used for the component." }, "v-btn/size": { "type": "string | number", "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/location": { "type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L7-L13\" target=\"_blank\">Anchor</a>", "description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/location.json))" }, "v-btn/color": { "type": "string", "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/density": { "type": "\"default\" | \"comfortable\" | \"compact\"", "description": "Adjusts the vertical height used by the component." }, "v-btn/height": { "type": "string | number", "description": "Sets the height for the component." }, "v-btn/border": { "type": "string | number | boolean", "description": "Applies border styles to component." }, "v-btn/elevation": { "type": "string | number", "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/rounded": { "type": "string | number | boolean", "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", "description": "Specify a custom tag used on the root element." }, "v-btn/icon": { "type": "boolean | string | (new () => any) | FunctionalComponent", "description": "Apply a specific icon using the [v-icon](/components/icons/) component. The button will become _round_