vuetify
Version:
Vue Material Component Framework
1,247 lines (1,246 loc) • 1.47 MB
JSON
{
"$schema": "http://json.schemastore.org/web-types",
"framework": "vue",
"name": "vuetify",
"version": "3.3.11",
"contributions": {
"html": {
"types-syntax": "typescript",
"description-markup": "markdown",
"tags": [
{
"name": "VAlert",
"source": {
"module": "./src/components/index.ts",
"symbol": "VAlert"
},
"description": "",
"doc-url": "https://vuetifyjs.com/api/v-alert",
"attributes": [
{
"name": "title",
"description": "Specify a title text for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "text",
"description": "Specify content text for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "border",
"description": "Adds a colored border to the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | 'top' | 'end' | 'bottom' | 'start'\n"
}
},
{
"name": "type",
"description": "Create a specialized alert that uses a contextual color and has a pre-defined icon.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "'success' | 'info' | 'warning' | 'error'\n"
}
},
{
"name": "borderColor",
"description": "Specifies the color of the border. Accepts any color value.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "closable",
"description": "Adds a close icon that can hide the alert.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "closeIcon",
"description": "Change the default icon used for **closable** alerts.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "'$close'",
"value": {
"kind": "expression",
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n"
}
},
{
"name": "closeLabel",
"description": "Text used for *aria-label* on **closable** alerts. Can also be customized globally in [Internationalization](/customization/internationalization).",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "'$vuetify.close'",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "icon",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "false",
"value": {
"kind": "expression",
"type": " | false\n | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n"
}
},
{
"name": "modelValue",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "prominent",
"description": "Displays a larger vertically centered icon to draw more attention.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "density",
"description": "Adjusts the vertical height used by the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "'default'",
"value": {
"kind": "expression",
"type": "'default' | 'comfortable' | 'compact'\n"
}
},
{
"name": "height",
"description": "Sets the height for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "maxHeight",
"description": "Sets the maximum height for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "maxWidth",
"description": "Sets the maximum width for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "minHeight",
"description": "Sets the minimum height for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "minWidth",
"description": "Sets the minimum width for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "width",
"description": "Sets the width for the component.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "elevation",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation).",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "location",
"description": "Specifies the component's location. Can combine by using a space separated string",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n"
}
},
{
"name": "position",
"description": "MISSING DESCRIPTION",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n"
}
},
{
"name": "rounded",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius).",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean\n"
}
},
{
"name": "tag",
"description": "Specify a custom tag used on the root element.",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "'div'",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "theme",
"description": "Specify a theme for this component and all of its children",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "color",
"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)",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "variant",
"description": "Applies a distinct style to the component",
"doc-url": "https://vuetifyjs.com/api/v-alert#props",
"default": "'flat'",
"value": {
"kind": "expression",
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n"
}
}
],
"events": [
{
"name": "click:close",
"description": "Emitted when close icon is clicked",
"doc-url": "https://vuetifyjs.com/api/v-alert#events",
"arguments": [
{
"name": "argument",
"type": "[MouseEvent]\n"
}
]
},
{
"name": "update:modelValue",
"description": "Event that is emitted when the component's model changes",
"doc-url": "https://vuetifyjs.com/api/v-alert#events",
"arguments": [
{
"name": "argument",
"type": "[boolean]\n"
}
]
}
],
"slots": [
{
"name": "default",
"description": "The default Vue slot.",
"doc-url": "https://vuetifyjs.com/api/v-alert#slots"
},
{
"name": "prepend",
"description": "Slot for icon at beginning of alert.",
"doc-url": "https://vuetifyjs.com/api/v-alert#slots"
},
{
"name": "title",
"description": "Slot for the component's title content",
"doc-url": "https://vuetifyjs.com/api/v-alert#slots"
},
{
"name": "text",
"description": "Slot for the component's text content",
"doc-url": "https://vuetifyjs.com/api/v-alert#slots"
},
{
"name": "append",
"description": "Slot for icon at end of alert.",
"doc-url": "https://vuetifyjs.com/api/v-alert#slots"
},
{
"name": "close",
"description": "Slot for icon used in **dismissible** prop.",
"doc-url": "https://vuetifyjs.com/api/v-alert#slots",
"vue-properties": [
{
"name": "props",
"type": "Record<string, any>"
}
]
}
],
"vue-model": {
"prop": "modelValue",
"event": "update:modelValue"
}
},
{
"name": "VAlertTitle",
"source": {
"module": "./src/components/index.ts",
"symbol": "VAlertTitle"
},
"description": "",
"doc-url": "https://vuetifyjs.com/api/v-alert-title",
"attributes": [
{
"name": "tag",
"description": "Specify a custom tag used on the root element",
"doc-url": "https://vuetifyjs.com/api/v-alert-title#props",
"default": "'div'",
"value": {
"kind": "expression",
"type": "string\n"
}
}
],
"events": [],
"slots": [
{
"name": "default",
"description": "The default Vue slot.",
"doc-url": "https://vuetifyjs.com/api/v-alert-title#slots"
}
],
"vue-model": {
"prop": "modelValue",
"event": "update:modelValue"
}
},
{
"name": "VApp",
"source": {
"module": "./src/components/index.ts",
"symbol": "VApp"
},
"description": "",
"doc-url": "https://vuetifyjs.com/api/v-app",
"attributes": [
{
"name": "theme",
"description": "Specify a theme for this component and all of its children",
"doc-url": "https://vuetifyjs.com/api/v-app#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "fullHeight",
"description": "Sets the component height to 100%",
"doc-url": "https://vuetifyjs.com/api/v-app#props",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "overlaps",
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/master/packages/api-generator/src/locale/en/layout.json))",
"doc-url": "https://vuetifyjs.com/api/v-app#props",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]\n"
}
}
],
"events": [],
"slots": [
{
"name": "default",
"description": "The default Vue slot.",
"doc-url": "https://vuetifyjs.com/api/v-app#slots"
}
],
"vue-model": {
"prop": "modelValue",
"event": "update:modelValue"
}
},
{
"name": "VAppBar",
"source": {
"module": "./src/components/index.ts",
"symbol": "VAppBar"
},
"description": "",
"doc-url": "https://vuetifyjs.com/api/v-app-bar",
"attributes": [
{
"name": "title",
"description": "Specify a title text for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "flat",
"description": "Removes the component's **box-shadow**.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "border",
"description": "Applies border styles to component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean\n"
}
},
{
"name": "modelValue",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "density",
"description": "Adjusts the vertical height used by the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "'default'",
"value": {
"kind": "expression",
"type": "'default' | 'prominent' | 'comfortable' | 'compact'\n"
}
},
{
"name": "height",
"description": "Designates a specific height for the toolbar. Overrides the heights imposed by other props, e.g. **prominent**, **dense**, **extended**, etc.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "64",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "elevation",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation).",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "location",
"description": "Aligns the component towards the top or bottom.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "'top'",
"value": {
"kind": "expression",
"type": "'top' | 'bottom'\n"
}
},
{
"name": "absolute",
"description": "Applies position: absolute to the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "rounded",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius).",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean\n"
}
},
{
"name": "tag",
"description": "Specify a custom tag used on the root element.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "'header'",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "theme",
"description": "Specify a theme for this component and all of its children",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "color",
"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)",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "name",
"description": "Assign a specific name for layout registration.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "image",
"description": "Specifies a [v-img](/components/images) as the component's background.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "scrollBehavior",
"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.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "collapse",
"description": "Morphs the component into a collapsed state, reducing its maximum width.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "extended",
"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**.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "extensionHeight",
"description": "Designate an explicit height for the `extension` slot.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "48",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "floating",
"description": "Applies **display: inline-flex** to the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "order",
"description": "Adjust the order of the component in relation to its registration order.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "0",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "scrollTarget",
"description": "The element to target for scrolling events. Uses `window` by default.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "scrollThreshold",
"description": "The amount of scroll distance down before **scroll-behavior** activates.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#props",
"default": "300",
"value": {
"kind": "expression",
"type": "string | number\n"
}
}
],
"events": [
{
"name": "update:modelValue",
"description": "Event that is emitted when the component's model changes",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#events",
"arguments": [
{
"name": "argument",
"type": "[boolean]\n"
}
]
}
],
"slots": [
{
"name": "default",
"description": "The default Vue slot.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#slots"
},
{
"name": "image",
"description": "Expects the [`v-img`](/components/images/) component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#slots"
},
{
"name": "prepend",
"description": "Adds an item outside the input and before input content",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#slots"
},
{
"name": "append",
"description": "Adds an item inside the input and after input content",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#slots"
},
{
"name": "title",
"description": "Slot for the component's title content",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#slots"
},
{
"name": "extension",
"description": "Slot positioned directly under the main content of the toolbar. Height of this slot can be set explicitly with the **extension-height** prop.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar#slots"
}
],
"vue-model": {
"prop": "modelValue",
"event": "update:modelValue"
}
},
{
"name": "VAppBarNavIcon",
"source": {
"module": "./src/components/index.ts",
"symbol": "VAppBarNavIcon"
},
"description": "",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon",
"attributes": [
{
"name": "symbol",
"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/) ",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "any\n"
}
},
{
"name": "text",
"description": "Specify content text for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "flat",
"description": "Removes the button box shadow.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "border",
"description": "Applies border styles to component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean\n"
}
},
{
"name": "icon",
"description": "Apply a specific icon using the [v-icon](/components/icons/) component. The button will become _round_.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "'$menu'",
"value": {
"kind": "expression",
"type": " | boolean\n | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n"
}
},
{
"name": "density",
"description": "Adjusts the vertical height used by the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "'default'",
"value": {
"kind": "expression",
"type": "'default' | 'comfortable' | 'compact'\n"
}
},
{
"name": "height",
"description": "Sets the height for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "maxHeight",
"description": "Sets the maximum height for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "maxWidth",
"description": "Sets the maximum width for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "minHeight",
"description": "Sets the minimum height for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "minWidth",
"description": "Sets the minimum width for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "width",
"description": "Sets the width for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "elevation",
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation).",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "location",
"description": "Specifies the component's location. Can combine by using a space separated string",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n"
}
},
{
"name": "position",
"description": "MISSING DESCRIPTION",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "'static' | 'relative' | 'fixed' | 'absolute' | 'sticky'\n"
}
},
{
"name": "rounded",
"description": "Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius).",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean\n"
}
},
{
"name": "tag",
"description": "Specify a custom tag used on the root element.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "'button'",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "theme",
"description": "Specify a theme for this component and all of its children",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "color",
"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)",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "variant",
"description": "Applies a distinct style to the component",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "'text'",
"value": {
"kind": "expression",
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n"
}
},
{
"name": "value",
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "any\n"
}
},
{
"name": "size",
"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**.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "'default'",
"value": {
"kind": "expression",
"type": "string | number\n"
}
},
{
"name": "active",
"description": "Controls the **active** state of the item. This is typically used to highlight the component",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "prependIcon",
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n"
}
},
{
"name": "appendIcon",
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n"
}
},
{
"name": "block",
"description": "Expands the button to 100% of available space.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "stacked",
"description": "Displays the button as a flex-column.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "ripple",
"description": "Applies the [v-ripple](/directives/ripple) directive.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | { class: string }\n"
}
},
{
"name": "disabled",
"description": "Removes the ability to click or target the component",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "selectedClass",
"description": "Configure the active CSS class applied when an item is selected.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "loading",
"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",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "string | boolean\n"
}
},
{
"name": "href",
"description": "Designates the component as anchor and applies the **href** attribute.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "replace",
"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.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "exact",
"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.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "to",
"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.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#props",
"value": {
"kind": "expression",
"type": "unknown\n"
}
}
],
"events": [],
"slots": [
{
"name": "default",
"description": "The default Vue slot.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#slots"
},
{
"name": "prepend",
"description": "Adds an item outside the input and before input content",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#slots"
},
{
"name": "append",
"description": "Adds an item inside the input and after input content",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#slots"
},
{
"name": "loader",
"description": "Slot for custom loader (displayed when [loading](#props-loading) prop is equal to true)",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-nav-icon#slots"
}
],
"vue-model": {
"prop": "modelValue",
"event": "update:modelValue"
}
},
{
"name": "VAppBarTitle",
"source": {
"module": "./src/components/index.ts",
"symbol": "VAppBarTitle"
},
"description": "",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-title",
"attributes": [
{
"name": "text",
"description": "Specify content text for the component.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-title#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "tag",
"description": "Specify a custom tag used on the root element.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-title#props",
"default": "'div'",
"value": {
"kind": "expression",
"type": "string\n"
}
}
],
"events": [],
"slots": [
{
"name": "default",
"description": "The default Vue slot.",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-title#slots"
},
{
"name": "text",
"description": "Slot for the component's text content",
"doc-url": "https://vuetifyjs.com/api/v-app-bar-title#slots"
}
],
"vue-model": {
"prop": "modelValue",
"event": "update:modelValue"
}
},
{
"name": "VAutocomplete",
"source": {
"module": "./src/components/index.ts",
"symbol": "VAutocomplete"
},
"description": "",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete",
"attributes": [
{
"name": "flat",
"description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "type",
"description": "Sets input type",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "'text'",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "modelValue",
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "null",
"value": {
"kind": "expression",
"type": "any\n"
}
},
{
"name": "error",
"description": "Puts the input in a manual error state",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "density",
"description": "Adjusts the vertical height used by the component.",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "'default'",
"value": {
"kind": "expression",
"type": "'default' | 'comfortable' | 'compact'\n"
}
},
{
"name": "reverse",
"description": "Reverses the orientation ",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean\n"
}
},
{
"name": "rounded",
"description": "Adds a border radius to the input",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean\n"
}
},
{
"name": "theme",
"description": "Specify a theme for this component and all of its children",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "color",
"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)",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "variant",
"description": "Applies a distinct style to the component",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "'filled'",
"value": {
"kind": "expression",
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n"
}
},
{
"name": "name",
"description": "Sets the component's name attribute.",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "id",
"description": "Sets the DOM id on the component",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"value": {
"kind": "expression",
"type": "string\n"
}
},
{
"name": "items",
"description": "An array of strings or objects used for automatically generating children components",
"doc-url": "https://vuetifyjs.com/api/v-autocomplete#props",
"default": "[]",
"value": {