{ "$schema": "http://json.schemastore.org/web-types", "framework": "vue", "name": "vuetify", "version": "2.7.1", "contributions": { "html": { "types-syntax": "typescript", "description-markup": "markdown", "tags": [ { "name": "VApp", "source": { "module": "./src/components/index.ts", "symbol": "VApp" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-app", "attributes": [ { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-app#props", "default": "'app'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-app#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VAppBar", "source": { "module": "./src/components/index.ts", "symbol": "VAppBar" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar", "attributes": [ { "name": "absolute", "description": "Applies position: absolute to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "app", "description": "Designates the component as part of the application layout. Used for dynamically adjusting content sizing. Components using this prop should reside **outside** of `v-main` component to function properly. You can find more information about layouts on the [application page](/components/application). **Note:** this prop automatically applies **position: fixed** to the layout element. You can overwrite this functionality by using the `absolute` prop", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clipped-left", "description": "Designates that the application's `v-navigation-drawer` that is positioned on the left is below the app-bar.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clipped-right", "description": "Designates that the application's `v-navigation-drawer` that is positioned on the right is below the app-bar.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "collapse", "description": "Puts the toolbar into a collapsed state reducing its maximum width.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "collapse-on-scroll", "description": "Puts the app-bar into a collapsed state when scrolling.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the height of the toolbar content to 48px (96px when using the **prominent** prop).", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "elevate-on-scroll", "description": "Elevates the app-bar when scrolling.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "extension-height", "description": "Specify an explicit height for the `extension` slot. ", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "48", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "fade-img-on-scroll", "description": "When using the **src** prop or `img` slot, will fade the image when scrolling.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Removes the toolbar's box-shadow.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "floating", "description": "Applies **display: inline-flex** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-on-scroll", "description": "Hides the app-bar when scrolling. Will still show the `extension` slot.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "inverted-scroll", "description": "Hides the app-bar when scrolling down and displays it when scrolling up.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prominent", "description": "Increases the height of the toolbar content to 128px.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "scroll-off-screen", "description": "Hides the app-bar when scrolling. Will **NOT** show the `extension` slot.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "scroll-target", "description": "Designates the element to target for scrolling events. Uses `window` by default.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "scroll-threshold", "description": "The amount of scroll distance down before **hide-on-scroll** activates.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "short", "description": "Reduce the height of the toolbar content to 56px (112px when using the **prominent** prop).", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "shrink-on-scroll", "description": "Shrinks a **prominent** toolbar to a **dense** or **short** (default) one when scrolling.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "src", "description": "Image source. See `v-img` for details", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "'header'", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.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. If this slot has no content, the **extended** prop may be used instead.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#slots" }, { "name": "img", "description": "Expects the [v-img](/components/images) component. Scoped **props** should be applied with `v-bind=\"props\"`.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar#slots", "vue-properties": [ { "name": "props", "type": "{ height: string, src: string | srcObject }" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VAppBarNavIcon", "source": { "module": "./src/components/index.ts", "symbol": "VAppBarNavIcon" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar-nav-icon", "attributes": [], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar-nav-icon#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VAppBarTitle", "source": { "module": "./src/components/index.ts", "symbol": "VAppBarTitle" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar-title", "attributes": [], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-app-bar-title#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VAlert", "source": { "module": "./src/components/index.ts", "symbol": "VAlert" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-alert", "attributes": [ { "name": "border", "description": "Puts a border on the alert. Accepts **top** \\| **right** \\| **bottom** \\| **left**.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "close-icon", "description": "Change the default icon used for **dismissible** alerts.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "'$cancel'", "value": { "kind": "expression", "type": "string" } }, { "name": "close-label", "description": "Text used for *aria-label* on **dismissible** alerts. Can also be customizing globally in [Internationalization](/customization/internationalization).", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "'$vuetify.close'", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "colored-border", "description": "Applies the defined **color** to the alert's border.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Decreases component's height.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dismissible", "description": "Adds a close icon that can hide the alert.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "icon", "description": "Designates a specific icon.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "outlined", "description": "Makes the background transparent and applies a thin border.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prominent", "description": "Displays a larger vertically centered icon to draw more attention.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "text", "description": "Applies the defined **color** to text and a low opacity background of the same.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tile", "description": "Removes the component's border-radius.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "type", "description": "Specify a **success**, **info**, **warning** or **error** alert. Uses the contextual color and has a pre-defined icon.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-alert#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Slot for icon at end of alert.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#slots" }, { "name": "close", "description": "Slot for icon used in **dismissible** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#slots", "vue-properties": [ { "name": "toggle", "type": "Function" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#slots" }, { "name": "prepend", "description": "Slot for icon at beginning of alert.", "doc-url": "https://www.vuetifyjs.com/api/v-alert#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VAutocomplete", "source": { "module": "./src/components/index.ts", "symbol": "VAutocomplete" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "'$dropdown'", "value": { "kind": "expression", "type": "string" } }, { "name": "append-outer-icon", "description": "Appends an icon to the outside the component's input, uses same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "auto-select-first", "description": "When searching, will always highlight the first option", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "autofocus", "description": "Enables autofocus", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "cache-items", "description": "Keeps a local _unique_ copy of all items that have been passed through the **items** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "chips", "description": "Changes display of selections to chips", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clear-icon", "description": "Applied when using **clearable** and the input is dirty", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "'$clear'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Add input clear functionality, default icon is Material Design Icons **mdi-clear**", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "counter", "description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "counter-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "deletable-chips", "description": "Adds a remove icon to selected chips", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-lookup", "description": "Disables keyboard lookup", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the input", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "filled", "description": "Applies the alternate filled input style", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "filter", "description": "The filtering algorithm used when searching. [example](https://github.com/vuetifyjs/vuetify/blob/v2-stable/packages/vuetify/src/components/VAutocomplete/VAutocomplete.ts#L40)", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "(item, queryText, itemText) => {}", "value": { "kind": "expression", "type": "function" } }, { "name": "flat", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Designates input type as full-width", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hide-no-data", "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.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-selected", "description": "Do not display in the select menu items that are already selected. Also removes checkboxes from the list when multiple", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "item-color", "description": "Sets color of selected items", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-disabled", "description": "Set property of **items**'s disabled value", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "disabled", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-text", "description": "Set property of **items**'s text value", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "text", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-value", "description": "Set property of **items**'s value - **must be primitive**. Dot notation is supported. **Note:** This is currently not supported with `v-combobox` [GitHub Issue](https://github.com/vuetifyjs/vuetify/issues/5479)", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "value", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "items", "description": "Can be an array of objects or array of strings. When using objects, will look for a text, value and disabled keys. This can be changed using the **item-text**, **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.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "menu-props", "description": "Pass props through to the `v-menu` component. Accepts either a string for boolean props `menu-props=\"auto, overflowY\"`, or an object `:menu-props=\"{ auto: true, overflowY: true }\"`", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "{\n closeOnClick: false,\n closeOnContentClick: false,\n disableKeys: true,\n openOnClick: false,\n maxHeight: 304,\n offsetY: true,\n offsetOverflow: true,\n transition: false\n}", "value": { "kind": "expression", "type": [ "string", "array", "object" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Changes select to multiple. Accepts array for value", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "no-data-text", "description": "Display text when there is no data", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "'$vuetify.noDataText'", "value": { "kind": "expression", "type": "string" } }, { "name": "no-filter", "description": "Do not apply filtering when searching. Useful when data is being filtered server side", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-clear", "description": "When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Applies the outlined style to the input", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-placeholder", "description": "Forces placeholder to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "placeholder", "description": "Sets the input's placeholder text", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prefix", "description": "Displays prefix text", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-inner-icon", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-object", "description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Reverses the input orientation", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the input", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "search-input", "description": "Search value. Can be used with `.sync` modifier.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "shaped", "description": "Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-line", "description": "Label does not move on focus/dirty", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "small-chips", "description": "Changes display of selections to chips with the **small** property", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo", "description": "Changes the style of the input", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo-inverted", "description": "Reduces element opacity until focused", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "suffix", "description": "Displays suffix text", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "The comparison algorithm used for values. [More info](https://github.com/vuetifyjs/vuetify/blob/v2-stable/packages/vuetify/src/util/helpers.ts)", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#props", "default": "(a: any, b: any): boolean", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "blur", "description": "Emitted when the input is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:append-outer", "description": "Emitted when appended outer icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:clear", "description": "Emitted when clearable icon clicked", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend-inner", "description": "Emitted when prepended inner icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "focus", "description": "Emitted when component is focused", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "keydown", "description": "Emitted when **any** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:list-index", "description": "Emitted when menu item is selected using keyboard arrows", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:search-input", "description": "The `search-input.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "append-item", "description": "Adds an item after menu content", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "append-outer", "description": "Adds an item outside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "counter", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots", "vue-properties": [ { "name": "props", "type": "{\"dark\":\"boolean\",\"light\":\"boolean\",\"max\":\"string | number\",\"value\":\"string\"}" } ] }, { "name": "item", "description": "Define a custom item appearance", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "on", "type": "object // Only needed when providing your own v-list-item" }, { "name": "attrs", "type": "object // Only needed when providing your own v-list-item" } ] }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "no-data", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "prepend-inner", "description": "Adds an item inside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "prepend-item", "description": "Adds an item before menu content", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots" }, { "name": "selection", "description": "Define a custom selection appearance", "doc-url": "https://www.vuetifyjs.com/api/v-autocomplete#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "index", "type": "number" }, { "name": "select", "type": "function" }, { "name": "selected", "type": "boolean" }, { "name": "disabled", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VAvatar", "source": { "module": "./src/components/index.ts", "symbol": "VAvatar" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-avatar", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "left", "description": "Designates that the avatar is on the left side of a component. This is hooked into by components such as [v-chip](/components/chips) and [v-btn](/components/buttons).", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "right", "description": "Designates that the avatar is on the right side of a component. This is hooked into by components such as [v-chip](/components/chips) and [v-btn](/components/buttons).", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "size", "description": "Sets the height and width of the component.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "48", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-avatar#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBadge", "source": { "module": "./src/components/index.ts", "symbol": "VBadge" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-badge", "attributes": [ { "name": "avatar", "description": "Removes badge padding for the use of the `v-avatar` in the **badge** slot.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bordered", "description": "Applies a **2px** by default and **1.5px** border around the badge when using the **dot** property.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "content", "description": "Any content you want injected as text into the badge.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dot", "description": "Reduce the size of the badge and hide its contents", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "icon", "description": "Designates a specific icon used in the badge.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "inline", "description": "Moves the badge to be inline with the wrapping element. Supports the usage of the **left** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "label", "description": "The **aria-label** used for the badge", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "'$vuetify.badge'", "value": { "kind": "expression", "type": "string" } }, { "name": "left", "description": "Aligns the component towards the left.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "offset-x", "description": "Offset the badge on the x-axis.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "offset-y", "description": "Offset the badge on the y-axis.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "overlap", "description": "Overlaps the slotted content on top of the component.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tile", "description": "Removes the component's border-radius.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "'scale-rotate-transition'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#props", "default": "true", "value": { "kind": "expression", "type": "any" } } ], "events": [], "slots": [ { "name": "badge", "description": "The slot used for the badge's content.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-badge#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBanner", "source": { "module": "./src/components/index.ts", "symbol": "VBanner" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-banner", "attributes": [ { "name": "app", "description": "When used inside of `v-main`, will calculate top based upon application `v-toolbar` and `v-system-bar`.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "icon", "description": "Designates a specific icon.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "icon-color", "description": "Designates a specific icon color.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "mobile-breakpoint", "description": "Sets the designated mobile breakpoint for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-line", "description": "Forces the banner onto a single line.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "sticky", "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).", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "actions", "description": "The slot used for the action's content such as a [v-btn](/components/buttons). The **dismiss** function in this slots scope, when invoked, will close the banner.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#slots", "vue-properties": [ { "name": "dismiss", "type": "(): void" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#slots" }, { "name": "icon", "description": "The slot used for the icon's content.", "doc-url": "https://www.vuetifyjs.com/api/v-banner#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBottomNavigation", "source": { "module": "./src/components/index.ts", "symbol": "VBottomNavigation" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "active-class", "description": "The class applied to a [v-btn](/components/buttons) when activated.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "'v-btn--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "app", "description": "Designates the component as part of the application layout. Used for dynamically adjusting content sizing. Components using this prop should reside **outside** of `v-main` component to function properly. You can find more information about layouts on the [application page](/components/application). **Note:** this prop automatically applies **position: fixed** to the layout element. You can overwrite this functionality by using the `absolute` prop", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "grow", "description": "Force [v-btn](/components/buttons)s to take up all available space.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "56", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-on-scroll", "description": "Will transition the navigation off screen when scrolling up.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "horizontal", "description": "Uses an alternative horizontal styling for [v-btn](/components/buttons).", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "input-value", "description": "Controls whether the component is visible or hidden. Supports the **.sync** modifier.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "scroll-target", "description": "Designates the element to target for scrolling events. Uses `window` by default.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "scroll-threshold", "description": "The amount of scroll distance down before **hide-on-scroll** activates.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "shift", "description": "Hides text of [v-btn](/components/buttons)s when they are not active.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Holds the value of the currently active [v-btn](/components/buttons). If the button has no value supplied, its index will be used instead..", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "change", "description": "The value of currently selected button. If no value is assigned, will be the current index of the button.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "update:input-value", "description": "The event used for `input-value.sync`.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#events", "arguments": [ { "name": "argument", "type": "string | number" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-navigation#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBottomSheet", "source": { "module": "./src/components/index.ts", "symbol": "VBottomSheet" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet", "attributes": [ { "name": "activator", "description": "Designate a custom activator when the `activator` slot is not used. String can be any valid querySelector and Object can be any valid Node.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "close-delay", "description": "Milliseconds to wait before closing component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "content-class", "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.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the ability to open the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fullscreen", "description": "Changes layout for fullscreen display.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-overlay", "description": "Hides the display of the overlay.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "inset", "description": "Reduces the sheet content maximum width to 70%.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "internal-activator", "description": "Detaches the menu content inside of the component as opposed to the document.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "no-click-animation", "description": "Disables the bounce effect when clicking outside of a `v-dialog`'s content when using the **persistent** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-delay", "description": "Milliseconds to wait before opening component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "open-on-click", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-focus", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "'center center'", "value": { "kind": "expression", "type": "string" } }, { "name": "overlay-color", "description": "Sets the overlay color.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "overlay-opacity", "description": "Sets the overlay opacity.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "persistent", "description": "Clicking outside of the element or pressing **esc** key will not deactivate it.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "retain-focus", "description": "Tab focus will return to the first child of the dialog by default. Disable this when using external tools that require focus such as TinyMCE or vue-clipboard.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "scrollable", "description": "When set to true, expects a `v-card` and a `v-card-text` component with a designated height. For more information, check out the [scrollable example](/components/dialogs#scrollable).", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "'bottom-sheet-transition'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } } ], "events": [], "slots": [ { "name": "activator", "description": "When used, will activate the component when clicked (or hover for specific components). This manually stops the event propagation. Without this slot, if you open the component through its model, you will need to manually stop the event propagation", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#slots", "vue-properties": [ { "name": "on", "type": "{ [eventName]: eventHandler }" }, { "name": "value", "type": "boolean" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-bottom-sheet#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBreadcrumbs", "source": { "module": "./src/components/index.ts", "symbol": "VBreadcrumbs" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs", "attributes": [ { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "divider", "description": "Specifies the dividing character between items.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#props", "default": "'/'", "value": { "kind": "expression", "type": "string" } }, { "name": "items", "description": "An array of objects for each breadcrumb.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "large", "description": "Increase the font-size of the breadcrumb item text to 16px (14px default).", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#slots" }, { "name": "divider", "description": "The slot used for dividers.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#slots" }, { "name": "item", "description": "The slot used to override default `v-breadcrumbs-item` behavior when using the **items** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs#slots", "vue-properties": [ { "name": "item", "type": "any[]" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBreadcrumbsItem", "source": { "module": "./src/components/index.ts", "symbol": "VBreadcrumbsItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "'v-breadcrumbs__item--disabled'", "value": { "kind": "expression", "type": "string" } }, { "name": "append", "description": "Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "exact-active-class", "description": "Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "exact-path", "description": "Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "href", "description": "Designates the component as anchor and applies the **href** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "link", "description": "Designates that the component is a link. This is automatic when using the **href** or **to** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "nuxt", "description": "Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/).", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "target", "description": "Designates the target attribute. This should only be applied when using the **href** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "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://www.vuetifyjs.com/api/v-breadcrumbs-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-item#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBreadcrumbsDivider", "source": { "module": "./src/components/index.ts", "symbol": "VBreadcrumbsDivider" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-divider", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-breadcrumbs-divider#props", "default": "'li'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBtn", "source": { "module": "./src/components/index.ts", "symbol": "VBtn" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-btn", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "", "value": { "kind": "expression", "type": "string" } }, { "name": "append", "description": "Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "block", "description": "Expands the button to 100% of available space.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "depressed", "description": "Removes the button box shadow.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "exact-active-class", "description": "Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "exact-path", "description": "Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fab", "description": "Designates the button as a floating-action-button. Button will become _round_.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "href", "description": "Designates the component as anchor and applies the **href** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "icon", "description": "Designates the button as icon. Button will become _round_ and applies the **text** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "input-value", "description": "Controls the button's active state.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "large", "description": "Makes the component large.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "left", "description": "Aligns the component towards the left. This should be used with the **absolute** or **fixed** props.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "link", "description": "Designates that the component is a link. This is automatic when using the **href** or **to** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loading", "description": "Adds a loading icon animation.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nuxt", "description": "Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/).", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Makes the background transparent and applies a thin border.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "plain", "description": "Removes the default background change applied when hovering over the button.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "retain-focus-on-click", "description": "Don't blur on click.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "right", "description": "Aligns the component towards the right. This should be used with the **absolute** or **fixed** props.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "rounded", "description": "Applies a large border radius on the button.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "small", "description": "Makes the component small.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "'button'", "value": { "kind": "expression", "type": "string" } }, { "name": "target", "description": "Designates the target attribute. This should only be applied when using the **href** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "text", "description": "Makes the background transparent. When using the **color** prop, the color will be applied to the button text instead of the background.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "top", "description": "Aligns the content towards the top.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "type", "description": "Set the button's **type** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "'button'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "x-large", "description": "Makes the component extra large.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "x-small", "description": "Makes the component extra small.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "click", "description": "Event that is emitted when the component is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#slots" }, { "name": "loader", "description": "Custom loader.", "doc-url": "https://www.vuetifyjs.com/api/v-btn#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VBtnToggle", "source": { "module": "./src/components/index.ts", "symbol": "VBtnToggle" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "'v-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "background-color", "description": "Changes the background-color for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "borderless", "description": "Removes the group's border.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the button size and padding.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "group", "description": "Generally used in [v-toolbar](/components/toolbars) and [v-app-bar](/components/app-bars). Removes background color, border and increases space between the buttons", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Round edge buttons", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's border-radius.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#events", "arguments": [ { "name": "argument", "type": "any[] | any" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-btn-toggle#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCalendar", "source": { "module": "./src/components/index.ts", "symbol": "VCalendar" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-calendar", "attributes": [ { "name": "categories", "description": "Specifies what categories to display in the `category` view. This controls the order of the categories as well. If the calendar uses events any categories specified in those events not specified in this value are dynamically rendered in the view unless `category-hide-dynamic` is true.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "array", "string" ] } }, { "name": "category-days", "description": "The number of days to render in the `category` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "category-for-invalid", "description": "The category to place events in that have invalid categories. A category is invalid when it is not a string. By default events without a category are not displayed until this value is specified.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "category-hide-dynamic", "description": "Sets whether categories specified in an event should be hidden if it's not defined in `categories`.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "category-show-all", "description": "Set whether the `category` view should show all defined `categories` even if there are no events for a category.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "category-text", "description": "If categories is a list of objects, you can use this to determine what property to print out as the category text on the calendar. You can provide a function to do some logic or just define the prop name. It's similar to item-text on v-select", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "day-format", "description": "Formats day of the month string that appears in a day to a specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "end", "description": "The ending date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "event-category", "description": "Set property of *event*'s category. Instead of a property a function can be given which takes an event and returns the category.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "category", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "event-color", "description": "A background color for all events or a function which accepts an event object passed to the calendar to return a color.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "primary", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "event-end", "description": "Set property of *event*'s end timestamp.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "'end'", "value": { "kind": "expression", "type": "string" } }, { "name": "event-height", "description": "The height of an event in pixels in the `month` view and at the top of the `day` views.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "20", "value": { "kind": "expression", "type": "number" } }, { "name": "event-margin-bottom", "description": "Margin bottom for event", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "1", "value": { "kind": "expression", "type": "number" } }, { "name": "event-more", "description": "Whether the more 'button' is displayed on a calendar with too many events in a given day. It will say something like '5 more' and when clicked generates a `click:more` event.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "event-more-text", "description": "The text to display in the more 'button' given the number of hidden events.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "'$vuetify.calendar.moreEvents'", "value": { "kind": "expression", "type": "string" } }, { "name": "event-name", "description": "Set property of *event*'s displayed name, or a function which accepts an event object passed to the calendar as the first argument and a flag signalling whether the name is for a timed event (true) or an event over a day.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "name", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "event-overlap-mode", "description": "One of `stack`, `column`, or a custom render function", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "stack", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "event-overlap-threshold", "description": "A value in minutes that's used to determine whether two timed events should be placed in column beside each other or should be treated as slightly overlapping events.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "60", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "event-ripple", "description": "Applies the `v-ripple` directive.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "event-start", "description": "Set property of *event*'s start timestamp.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "'start'", "value": { "kind": "expression", "type": "string" } }, { "name": "event-text-color", "description": "A text color for all events or a function which accepts an event object passed to the calendar to return a color.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "white", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "event-timed", "description": "If Dates or milliseconds are used as the start or end timestamp of an event, this prop can be a string to a property on the event that is truthy if the event is a timed event or a function which takes the event and returns a truthy value if the event is a timed event.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "timed", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "events", "description": "An array of event objects with a property for a start timestamp and optionally a name and end timestamp. If an end timestamp is not given, the value of start will be used. If no name is given, you must provide an implementation for the `event` slot.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "first-interval", "description": "The first interval to display in the `day` view. If `intervalMinutes` is set to 60 and this is set to 9 the first time in the view is 9am.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "first-time", "description": "The first time to display in the `day` view. If specified, this overwrites any `firstInterval` value specified. This can be the number of minutes since midnight, a string in the format of `HH:mm`, or an object with number properties hour and minute.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string", "object" ] } }, { "name": "hide-header", "description": "If the header at the top of the `day` view should be visible.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "interval-count", "description": "The number of intervals to display in the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "24", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "interval-format", "description": "Formats time of day string that appears in the interval gutter of the `day` and `week` view to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "interval-height", "description": "The height of an interval in pixels in the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "48", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "interval-minutes", "description": "The number of minutes the intervals are in the `day` view. A common interval is 60 minutes so the intervals are an hour.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "60", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "interval-style", "description": "Returns CSS styling to apply to the interval.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "interval-width", "description": "The width of the interval gutter on the left side in the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "60", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "locale", "description": "The locale of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "locale-first-day-of-year", "description": "Sets the day that determines the first week of the year, starting with 0 for **Sunday**. For ISO 8601 this should be 4.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "0", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "max-days", "description": "The maximum number of days to display in the custom calendar if an `end` day is not set.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "7", "value": { "kind": "expression", "type": "number" } }, { "name": "min-weeks", "description": "The minimum number of weeks to display in the `month` or `week` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "1", "value": { "kind": "expression", "type": "any" } }, { "name": "month-format", "description": "Formats month string that appears in a day to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "now", "description": "Override the day & time which is considered now. This is in the format of `YYYY-MM-DD hh:mm:ss`. The calendar is styled according to now.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "short-intervals", "description": "If true, the intervals in the `day` view will be 9 AM as opposed to 09:00 AM", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "short-months", "description": "Whether the short versions of a month should be used (Jan vs January).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "short-weekdays", "description": "Whether the short versions of a weekday should be used (Mon vs Monday).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-interval-label", "description": "Checks if a given day and time should be displayed in the interval gutter of the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "show-month-on-first", "description": "Whether the name of the month should be displayed on the first day of the month.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-week", "description": "Whether week numbers should be displayed when using the `month` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "start", "description": "The starting date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "2023-08-09", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "type", "description": "A string which is one of `month`, `week`, `day`, `4day`, `custom-weekly`, `custom-daily`, and `category`. The custom types look at the `start` and `end` dates passed to the component as opposed to the `value`.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "'month'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "A date in the format of `YYYY-MM-DD` which determines what span of time for the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "weekday-format", "description": "Formats day of the week string that appears in the header to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "weekdays", "description": "Specifies which days of the week to display. To display Monday through Friday only, a value of `[1, 2, 3, 4, 5]` can be used. To display a week starting on Monday a value of `[1, 2, 3, 4, 5, 6, 0]` can be used.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#props", "default": "[0,1,2,3,4,5,6]", "value": { "kind": "expression", "type": [ "array", "string" ] } } ], "events": [ { "name": "change", "description": "The range of days displayed on the calendar changed. This is triggered on initialization. The event passed is an object with start and end date objects.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}}" } ] }, { "name": "click:date", "description": "The click event on the day of the month link. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "click:day", "description": "The click event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "click:day-category", "description": "The click event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "click:event", "description": "The click event on a specific event. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "click:interval", "description": "The click event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "click:more", "description": "The click event on the `X more` button on views with too many events in a day. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "click:time", "description": "The click event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "click:time-category", "description": "The click event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "contextmenu:date", "description": "The right-click event on the day of the month link. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "contextmenu:day", "description": "The right-click event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "contextmenu:day-category", "description": "The right-click event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "contextmenu:event", "description": "The right-click event on an event. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "contextmenu:interval", "description": "The right-click event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "contextmenu:time", "description": "The right-click event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "contextmenu:time-category", "description": "The right-click event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "input", "description": "An alias to the `click:date` event used to support v-model.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}" } ] }, { "name": "mousedown:day", "description": "The mousedown event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousedown:day-category", "description": "The mousedown event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousedown:event", "description": "The mousedown event on an event. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "mousedown:interval", "description": "The mousedown event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousedown:time", "description": "The mousedown event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousedown:time-category", "description": "The mousedown event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseenter:day", "description": "The mouseenter event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseenter:day-category", "description": "The mouseenter event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseenter:event", "description": "The mouseenter event on an event. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "mouseenter:interval", "description": "The mouseenter event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseenter:time", "description": "The mouseenter event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseenter:time-category", "description": "The mouseenter event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseleave:day", "description": "The mouseleave event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseleave:day-category", "description": "The mouseleave event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseleave:event", "description": "The mouseleave event on an event. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "mouseleave:interval", "description": "The mouseleave event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseleave:time", "description": "The mouseleave event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseleave:time-category", "description": "The mouseleave event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousemove:day", "description": "The mousemove event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousemove:day-category", "description": "The mousemove event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousemove:event", "description": "The mousemove event on an event. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "mousemove:interval", "description": "The mousemove event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousemove:time", "description": "The mousemove event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mousemove:time-category", "description": "The mousemove event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseup:day", "description": "The mouseup event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseup:day-category", "description": "The mouseup event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseup:event", "description": "The mouseup event on an event. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "mouseup:interval", "description": "The mouseup event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseup:time", "description": "The mouseup event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "mouseup:time-category", "description": "The mouseup event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, MouseEvent" } ] }, { "name": "moved", "description": "One of the functions `next`, `prev`, and `move` was called. The event passed is the day object calculated for the movement.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}" } ] }, { "name": "touchend:day", "description": "The touchend event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchend:day-category", "description": "The touchend event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchend:event", "description": "The touchend event on am view. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "touchend:interval", "description": "The touchend event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchend:time", "description": "The touchend event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchend:time-category", "description": "The touchend event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchmove:day", "description": "The touchmove event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchmove:day-category", "description": "The touchmove event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchmove:event", "description": "The touchmove event on an `event` view. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "touchmove:interval", "description": "The touchmove event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchmove:time", "description": "The touchmove event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchmove:time-category", "description": "The touchmove event at a specific time in the `category` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchstart:day", "description": "The touchstart event on a day. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchstart:day-category", "description": "The touchstart event on a day in the `category` view. The event passed is the day object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchstart:event", "description": "The touchstart event on an event` view. The event passed is the day & time object.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\"event\":\"any\",\"eventParsed\":{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"},\"day\":{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"outside\":\"boolean\",\"start\":\"boolean\",\"end\":\"boolean\",\"timed\":\"boolean\",\"singleline\":\"boolean\",\"overlapsNoon\":\"boolean\",\"formatTime\":\"(time: VTimestamp, ampm: boolean): string\",\"timeSummary\":\"(): string\",\"eventSummary\":\"(): string\",\"nativeEvent\":\"MouseEvent | TouchEvent\"}" } ] }, { "name": "touchstart:interval", "description": "The touchstart event at a specific interval label in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchstart:time", "description": "The touchstart event at a specific time in the `day` view. The event passed is the day & time object. Native mouse event is passed as a second argument.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] }, { "name": "touchstart:time-category", "description": "The touchstart event at a specific time in the `category` view. The event passed is the day & time object Native mouse event is passed as a second argument..", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#events", "arguments": [ { "name": "argument", "type": "{\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean,\n timeToY: (time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false,\n timeDelta: (time: string | number | {hour: number, minute: number}): number | false,\n minutesToPixels: (minutes: number): number,\n week: [\n {\n date: string,\n time: string,\n year: number,\n month: number,\n day: number,\n hour: number,\n minute: number,\n weekday: number,\n hasDay: boolean,\n hasTime: boolean,\n past: boolean,\n present: boolean,\n future: boolean\n }\n ]\n}, TouchEvent" } ] } ], "slots": [ { "name": "category", "description": "The content placed in a category header for the `category` type. The category variable is null for events with invalid (non-string) categories.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" }, { "name": "week", "type": "[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}]" }, { "name": "category", "type": "string | null" } ] }, { "name": "day", "description": "The content that is placed in a `week` or `month` view. The day & time object is passed through this slots scope.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "outside", "type": "boolean" }, { "name": "index", "type": "number" }, { "name": "week", "type": "[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}]" }, { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" } ] }, { "name": "day-body", "description": "The content that is placed in a `day` view in the scrollable interval container. The day & time object is passed through this slots scope.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" }, { "name": "timeToY", "type": "(time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false" }, { "name": "timeDelta", "type": "(time: string | number | {hour: number, minute: number}): number | false" }, { "name": "minutesToPixels", "type": "(minutes: number): number" }, { "name": "week", "type": "[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}]" } ] }, { "name": "day-header", "description": "The content that is placed in a `day` view in the top container. The day & time object is passed through this slots scope.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" }, { "name": "timeToY", "type": "(time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false" }, { "name": "timeDelta", "type": "(time: string | number | {hour: number, minute: number}): number | false" }, { "name": "minutesToPixels", "type": "(minutes: number): number" }, { "name": "week", "type": "[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}]" } ] }, { "name": "day-label", "description": "The content that is placed in the day of the month space in the `custom-weekly` or `month` view. The day & time object is passed through this slots scope.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" } ] }, { "name": "day-label-header", "description": "The content that is placed in the day of the month space in the `week`, `day`, `4day`, or `custom-daily` view. The day & time object is passed through this slots scope.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" } ] }, { "name": "day-month", "description": "The content that is placed in the month space in the `week` or `month` view. The day & time object is passed through this slots scope.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" } ] }, { "name": "event", "description": "The content placed in an event. This ignores the `event-name` prop.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "event", "type": "any" }, { "name": "eventParsed", "type": "{\"input\":\"any\",\"start\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"startIdentifier\":\"number\",\"startTimestampIdentifier\":\"number\",\"end\":{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"},\"endIdentifier\":\"number\",\"endTimestampIdentifier\":\"number\",\"allDay\":\"boolean\",\"index\":\"number\",\"category\":\"string\"}" }, { "name": "day", "type": "{\"outside\":\"boolean\",\"index\":\"number\",\"week\":[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}],\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}" }, { "name": "outside", "type": "boolean" }, { "name": "start", "type": "boolean" }, { "name": "end", "type": "boolean" }, { "name": "timed", "type": "boolean" }, { "name": "singleline", "type": "boolean" }, { "name": "overlapsNoon", "type": "boolean" }, { "name": "formatTime", "type": "(time: VTimestamp, ampm: boolean): string" }, { "name": "timeSummary", "type": "(): string" }, { "name": "eventSummary", "type": "(): string" } ] }, { "name": "interval", "description": "The content that is placed in the interval space in the `day` view. The day & time object is passed through this slots scope.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar#slots", "vue-properties": [ { "name": "date", "type": "string" }, { "name": "time", "type": "string" }, { "name": "year", "type": "number" }, { "name": "month", "type": "number" }, { "name": "day", "type": "number" }, { "name": "hour", "type": "number" }, { "name": "minute", "type": "number" }, { "name": "weekday", "type": "number" }, { "name": "hasDay", "type": "boolean" }, { "name": "hasTime", "type": "boolean" }, { "name": "past", "type": "boolean" }, { "name": "present", "type": "boolean" }, { "name": "future", "type": "boolean" }, { "name": "timeToY", "type": "(time: string | number | {hour: number, minute: number}, clamp: boolean = false): number | false" }, { "name": "timeDelta", "type": "(time: string | number | {hour: number, minute: number}): number | false" }, { "name": "minutesToPixels", "type": "(minutes: number): number" }, { "name": "week", "type": "[{\"date\":\"string\",\"time\":\"string\",\"year\":\"number\",\"month\":\"number\",\"day\":\"number\",\"hour\":\"number\",\"minute\":\"number\",\"weekday\":\"number\",\"hasDay\":\"boolean\",\"hasTime\":\"boolean\",\"past\":\"boolean\",\"present\":\"boolean\",\"future\":\"boolean\"}]" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCalendarDaily", "source": { "module": "./src/components/index.ts", "symbol": "VCalendarDaily" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "day-format", "description": "Formats day of the month string that appears in a day to a specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "end", "description": "The ending date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "first-interval", "description": "The first interval to display in the `day` view. If `intervalMinutes` is set to 60 and this is set to 9 the first time in the view is 9am.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "first-time", "description": "The first time to display in the `day` view. If specified, this overwrites any `firstInterval` value specified. This can be the number of minutes since midnight, a string in the format of `HH:mm`, or an object with number properties hour and minute.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string", "object" ] } }, { "name": "hide-header", "description": "If the header at the top of the `day` view should be visible.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "interval-count", "description": "The number of intervals to display in the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "24", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "interval-format", "description": "Formats time of day string that appears in the interval gutter of the `day` and `week` view to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "interval-height", "description": "The height of an interval in pixels in the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "48", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "interval-minutes", "description": "The number of minutes the intervals are in the `day` view. A common interval is 60 minutes so the intervals are an hour.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "60", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "interval-style", "description": "Returns CSS styling to apply to the interval.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "interval-width", "description": "The width of the interval gutter on the left side in the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "60", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "locale", "description": "The locale of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "max-days", "description": "The maximum number of days to display in the custom calendar if an `end` day is not set.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "7", "value": { "kind": "expression", "type": "number" } }, { "name": "now", "description": "Override the day & time which is considered now. This is in the format of `YYYY-MM-DD hh:mm:ss`. The calendar is styled according to now.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "short-intervals", "description": "If true, the intervals in the `day` view will be 9 AM as opposed to 09:00 AM", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "short-weekdays", "description": "Whether the short versions of a weekday should be used (Mon vs Monday).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-interval-label", "description": "Checks if a given day and time should be displayed in the interval gutter of the `day` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "start", "description": "The starting date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "2023-08-09", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "weekday-format", "description": "Formats day of the week string that appears in the header to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "weekdays", "description": "Specifies which days of the week to display. To display Monday through Friday only, a value of `[1, 2, 3, 4, 5]` can be used. To display a week starting on Monday a value of `[1, 2, 3, 4, 5, 6, 0]` can be used.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-daily#props", "default": "[0,1,2,3,4,5,6]", "value": { "kind": "expression", "type": [ "array", "string" ] } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCalendarWeekly", "source": { "module": "./src/components/index.ts", "symbol": "VCalendarWeekly" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "day-format", "description": "Formats day of the month string that appears in a day to a specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "end", "description": "The ending date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "hide-header", "description": "If the header at the top of the `day` view should be visible.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "locale", "description": "The locale of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "locale-first-day-of-year", "description": "Sets the day that determines the first week of the year, starting with 0 for **Sunday**. For ISO 8601 this should be 4.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "0", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "min-weeks", "description": "The minimum number of weeks to display in the `month` or `week` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "1", "value": { "kind": "expression", "type": "any" } }, { "name": "month-format", "description": "Formats month string that appears in a day to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "now", "description": "Override the day & time which is considered now. This is in the format of `YYYY-MM-DD hh:mm:ss`. The calendar is styled according to now.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "short-months", "description": "Whether the short versions of a month should be used (Jan vs January).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "short-weekdays", "description": "Whether the short versions of a weekday should be used (Mon vs Monday).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-month-on-first", "description": "Whether the name of the month should be displayed on the first day of the month.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-week", "description": "Whether week numbers should be displayed when using the `month` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "start", "description": "The starting date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "2023-08-09", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "weekday-format", "description": "Formats day of the week string that appears in the header to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "weekdays", "description": "Specifies which days of the week to display. To display Monday through Friday only, a value of `[1, 2, 3, 4, 5]` can be used. To display a week starting on Monday a value of `[1, 2, 3, 4, 5, 6, 0]` can be used.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-weekly#props", "default": "[0,1,2,3,4,5,6]", "value": { "kind": "expression", "type": [ "array", "string" ] } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCalendarMonthly", "source": { "module": "./src/components/index.ts", "symbol": "VCalendarMonthly" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "day-format", "description": "Formats day of the month string that appears in a day to a specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "end", "description": "The ending date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "hide-header", "description": "If the header at the top of the `day` view should be visible.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "locale", "description": "The locale of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "locale-first-day-of-year", "description": "Sets the day that determines the first week of the year, starting with 0 for **Sunday**. For ISO 8601 this should be 4.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "0", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "min-weeks", "description": "The minimum number of weeks to display in the `month` or `week` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "1", "value": { "kind": "expression", "type": "any" } }, { "name": "month-format", "description": "Formats month string that appears in a day to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "now", "description": "Override the day & time which is considered now. This is in the format of `YYYY-MM-DD hh:mm:ss`. The calendar is styled according to now.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "short-months", "description": "Whether the short versions of a month should be used (Jan vs January).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "short-weekdays", "description": "Whether the short versions of a weekday should be used (Mon vs Monday).", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-month-on-first", "description": "Whether the name of the month should be displayed on the first day of the month.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-week", "description": "Whether week numbers should be displayed when using the `month` view.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "start", "description": "The starting date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "2023-08-09", "value": { "kind": "expression", "type": [ "string", "number", "date" ] } }, { "name": "weekday-format", "description": "Formats day of the week string that appears in the header to specified locale", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "weekdays", "description": "Specifies which days of the week to display. To display Monday through Friday only, a value of `[1, 2, 3, 4, 5]` can be used. To display a week starting on Monday a value of `[1, 2, 3, 4, 5, 6, 0]` can be used.", "doc-url": "https://www.vuetifyjs.com/api/v-calendar-monthly#props", "default": "[0,1,2,3,4,5,6]", "value": { "kind": "expression", "type": [ "array", "string" ] } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCard", "source": { "module": "./src/components/index.ts", "symbol": "VCard" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-card", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "append", "description": "Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "exact-active-class", "description": "Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "exact-path", "description": "Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Removes the card's elevation.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hover", "description": "Will apply an elevation of 4dp when hovered (default 2dp). You can find more information on the [elevation page](/styles/elevation).", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "href", "description": "Designates the component as anchor and applies the **href** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "img", "description": "Specifies an image background for the card. For more advanced implementations, it is recommended that you use the [v-img](/components/images) component. You can find a [v-img example here](/components/cards/#media-with-text).", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "link", "description": "Designates that the component is a link. This is automatic when using the **href** or **to** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "4", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nuxt", "description": "Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/).", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "raised", "description": "Specifies a higher default elevation (8dp). You can find more information on the [elevation page](/styles/elevation).", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "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://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "target", "description": "Designates the target attribute. This should only be applied when using the **href** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-card#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "click", "description": "Emitted when component is clicked - Will trigger component to ripple when clicked unless the `.native` modifier is used", "doc-url": "https://www.vuetifyjs.com/api/v-card#events", "arguments": [ { "name": "argument", "type": "void" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-card#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-card#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCardActions", "source": { "module": "./src/components/index.ts", "symbol": "VCardActions" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-card-actions", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-card-actions#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-card-actions#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCardSubtitle", "source": { "module": "./src/components/index.ts", "symbol": "VCardSubtitle" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-card-subtitle", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-card-subtitle#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-card-subtitle#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCardText", "source": { "module": "./src/components/index.ts", "symbol": "VCardText" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-card-text", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-card-text#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-card-text#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCardTitle", "source": { "module": "./src/components/index.ts", "symbol": "VCardTitle" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-card-title", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-card-title#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-card-title#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCarousel", "source": { "module": "./src/components/index.ts", "symbol": "VCarousel" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-carousel", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "'v-window-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "continuous", "description": "Determines whether carousel is continuous", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "cycle", "description": "Determines if the carousel should cycle through images.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "delimiter-icon", "description": "Sets icon for carousel delimiter", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "'$delimiter'", "value": { "kind": "expression", "type": "string" } }, { "name": "height", "description": "Sets the height for the component", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "500", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-delimiter-background", "description": "Hides the bottom delimiter background.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-delimiters", "description": "Hides the carousel's bottom delimiters.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "interval", "description": "The duration between image cycles. Requires the **cycle** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "6000", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "next-icon", "description": "The displayed icon for forcing pagination to the next item.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "$next", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "prev-icon", "description": "The displayed icon for forcing pagination to the previous item.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "$prev", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "progress", "description": "Displays a carousel progress bar. Requires the **cycle** prop and **interval**.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "progress-color", "description": "Applies specified color to progress bar.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "reverse", "description": "Reverse the normal transition direction.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-arrows", "description": "Displays arrows for next/previous navigation.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-arrows-on-hover", "description": "Displays navigation arrows only when the carousel is hovered over.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "touch", "description": "Provide a custom **left** and **right** function when swiped left or right.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "touchless", "description": "Disable touch support.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "vertical", "description": "Uses a vertical transition when changing windows.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "vertical-delimiters", "description": "Displays carousel delimiters vertically.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } } ], "events": [ { "name": "change", "description": "Emitted when the component value is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#events", "arguments": [ { "name": "argument", "type": "number" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#slots" }, { "name": "next", "description": "Slot displaying the arrow switching to the next item", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#slots", "vue-properties": [ { "name": "attrs", "type": "{ aria-label: string }" }, { "name": "on", "type": "{ click: eventHandler }" } ] }, { "name": "prev", "description": "Slot displaying the arrow switching to the previous item", "doc-url": "https://www.vuetifyjs.com/api/v-carousel#slots", "vue-properties": [ { "name": "attrs", "type": "{ aria-label: string }" }, { "name": "on", "type": "{ click: eventHandler }" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCarouselItem", "source": { "module": "./src/components/index.ts", "symbol": "VCarouselItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "append", "description": "Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "exact-active-class", "description": "Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "exact-path", "description": "Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "href", "description": "Designates the component as anchor and applies the **href** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "link", "description": "Designates that the component is a link. This is automatic when using the **href** or **to** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "nuxt", "description": "Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/).", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-carousel-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse-transition", "description": "Sets the reverse transition", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "target", "description": "Designates the target attribute. This should only be applied when using the **href** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "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://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "transition", "description": "The transition used when the component progressing through items. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "value", "description": "The value used when the component is selected in a group. If not provided, the index will be used.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-item#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCheckbox", "source": { "module": "./src/components/index.ts", "symbol": "VCheckbox" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "false-value", "description": "Sets value for falsy state", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "indeterminate", "description": "Sets an indeterminate state for the checkbox", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "indeterminate-icon", "description": "The icon used when in an indeterminate state", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "'$checkboxIndeterminate'", "value": { "kind": "expression", "type": "string" } }, { "name": "input-value", "description": "The **v-model** bound value", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Changes expected model to an array", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "off-icon", "description": "The icon used when inactive", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "'$checkboxOff'", "value": { "kind": "expression", "type": "string" } }, { "name": "on-icon", "description": "The icon used when active", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "'$checkboxOn'", "value": { "kind": "expression", "type": "string" } }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "true", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "true-value", "description": "Sets value for truthy state", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:indeterminate", "description": "The **indeterminate.sync** event.", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#slots" }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-checkbox#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSimpleCheckbox", "source": { "module": "./src/components/index.ts", "symbol": "VSimpleCheckbox" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables simple checkbox.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "indeterminate", "description": "Sets an indeterminate state for the simple checkbox.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "indeterminate-icon", "description": "The icon used when in an indeterminate state.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "'$checkboxIndeterminate'", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "off-icon", "description": "The icon used when inactive.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "'$checkboxOff'", "value": { "kind": "expression", "type": "string" } }, { "name": "on-icon", "description": "The icon used when active.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "'$checkboxOn'", "value": { "kind": "expression", "type": "string" } }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "A boolean value that represents whether the simple checkbox is checked.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-simple-checkbox#events", "arguments": [ { "name": "argument", "type": "Event" } ] } ], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VChip", "source": { "module": "./src/components/index.ts", "symbol": "VChip" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-chip", "attributes": [ { "name": "active", "description": "Determines whether the chip is visible or not.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "", "value": { "kind": "expression", "type": "string" } }, { "name": "append", "description": "Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "close", "description": "Adds remove button", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "close-icon", "description": "Change the default icon used for **close** chips", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "'$delete'", "value": { "kind": "expression", "type": "string" } }, { "name": "close-label", "description": "Text used for *aria-label* on the close button in **close** chips. Can also be customized globally in [Internationalization](/customization/internationalization).", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "'$vuetify.close'", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the chip, making it un-selectable", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "draggable", "description": "Makes the chip draggable", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "exact-active-class", "description": "Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "exact-path", "description": "Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "filter", "description": "Displays a selection icon when selected", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "filter-icon", "description": "Change the default icon used for **filter** chips", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "'$complete'", "value": { "kind": "expression", "type": "string" } }, { "name": "href", "description": "Designates the component as anchor and applies the **href** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "input-value", "description": "Controls the **active** state of the item. This is typically used to highlight the component.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "label", "description": "Removes circle edges", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "large", "description": "Makes the component large.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "link", "description": "Explicitly define the chip as a link", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "nuxt", "description": "Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/).", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Removes background and applies border and text color", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "pill", "description": "Remove `v-avatar` padding", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "small", "description": "Makes the component small.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "'span'", "value": { "kind": "expression", "type": "string" } }, { "name": "target", "description": "Designates the target attribute. This should only be applied when using the **href** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "text-color", "description": "Applies a specified color to the control text", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "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://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "value", "description": "The value used when a child of a [v-chip-group](/components/chip-groups).", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "x-large", "description": "Makes the component extra large.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "x-small", "description": "Makes the component extra small.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "click", "description": "Emitted when component is clicked, toggles chip if contained in a chip group - Will trigger component to ripple when clicked unless the `.native` modifier is used", "doc-url": "https://www.vuetifyjs.com/api/v-chip#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:close", "description": "Emitted when close icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-chip#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-chip#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:active", "description": "Emitted when close icon is clicked, sets active to `false`", "doc-url": "https://www.vuetifyjs.com/api/v-chip#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-chip#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VChipGroup", "source": { "module": "./src/components/index.ts", "symbol": "VChipGroup" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "'v-slide-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "center-active", "description": "Forces the selected chip to be centered", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "column", "description": "Remove horizontal pagination and wrap items as needed", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "mobile-breakpoint", "description": "Sets the designated mobile breakpoint for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "next-icon", "description": "Specify the icon to use for the next icon", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "'$next'", "value": { "kind": "expression", "type": "string" } }, { "name": "prev-icon", "description": "Specify the icon to use for the prev icon", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "'$prev'", "value": { "kind": "expression", "type": "string" } }, { "name": "show-arrows", "description": "Force the display of the pagination arrows", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the component value is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#events", "arguments": [ { "name": "argument", "type": "any[] | any" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-chip-group#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VColorPicker", "source": { "module": "./src/components/index.ts", "symbol": "VColorPicker" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker", "attributes": [ { "name": "canvas-height", "description": "Height of canvas", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "150", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables picker", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dot-size", "description": "Changes the size of the selection dot on the canvas", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "10", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-color-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "flat", "description": "Removes elevation", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-canvas", "description": "Hides canvas", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-inputs", "description": "Hides inputs", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-mode-switch", "description": "Hides mode switch", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-sliders", "description": "Hides sliders", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets mode of inputs. Available modes are 'rgba', 'hsla', and 'hexa'. Can be synced with the `.sync` modifier.", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "'rgba'", "value": { "kind": "expression", "type": "string" } }, { "name": "show-swatches", "description": "Displays color swatches", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "swatches", "description": "Sets the available color swatches to select from - This prop only accepts rgba hex strings", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "array" } }, { "name": "swatches-max-height", "description": "Sets the maximum height of the swatches section", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "150", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "value", "description": "Current color. This can be either a string representing a hex color, or an object representing a RGBA, HSLA, or HSVA value", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "object", "string" ] } }, { "name": "width", "description": "Sets the width of the color picker", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#props", "default": "300", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "input", "description": "Selected color. Depending on what you passed to the `value` prop this is either a string or an object", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#events", "arguments": [ { "name": "argument", "type": "string | object" } ] }, { "name": "update:color", "description": "Selected color. This is the internal representation of the color, containing all values.", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#events", "arguments": [ { "name": "argument", "type": "{\"alpha\":\"number\",\"hex\":\"string\",\"hexa\":\"string\",\"hsla\":{\"h\":\"number\",\"s\":\"number\",\"l\":\"number\",\"a\":\"number\"},\"hsva\":{\"h\":\"number\",\"s\":\"number\",\"v\":\"number\",\"a\":\"number\"},\"hue\":\"number\",\"rgba\":{\"r\":\"number\",\"g\":\"number\",\"b\":\"number\",\"a\":\"number\"}}" } ] }, { "name": "update:mode", "description": "Selected mode", "doc-url": "https://www.vuetifyjs.com/api/v-color-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VContent", "source": { "module": "./src/components/index.ts", "symbol": "VContent" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-content", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-content#props", "default": "'main'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCombobox", "source": { "module": "./src/components/index.ts", "symbol": "VCombobox" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-combobox", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "'$dropdown'", "value": { "kind": "expression", "type": "string" } }, { "name": "append-outer-icon", "description": "Appends an icon to the outside the component's input, uses same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "auto-select-first", "description": "When searching, will always highlight the first option", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "autofocus", "description": "Enables autofocus", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "cache-items", "description": "Keeps a local _unique_ copy of all items that have been passed through the **items** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "chips", "description": "Changes display of selections to chips", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clear-icon", "description": "Applied when using **clearable** and the input is dirty", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "'$clear'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Add input clear functionality, default icon is Material Design Icons **mdi-clear**", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "counter", "description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "counter-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "deletable-chips", "description": "Adds a remove icon to selected chips", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "delimiters", "description": "Accepts an array of strings that will trigger a new tag when typing. Does not replace the normal Tab and Enter keys.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-lookup", "description": "Disables keyboard lookup", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the input", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "filled", "description": "Applies the alternate filled input style", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "filter", "description": "The function used for filtering items", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "(item, queryText, itemText) => {}", "value": { "kind": "expression", "type": "function" } }, { "name": "flat", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Designates input type as full-width", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hide-no-data", "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.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-selected", "description": "Do not display in the select menu items that are already selected. Also removes checkboxes from the list when multiple", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "item-color", "description": "Sets color of selected items", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-disabled", "description": "Set property of **items**'s disabled value", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "disabled", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-text", "description": "Set property of **items**'s text value", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "text", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-value", "description": "Set property of **items**'s value - **must be primitive**. Dot notation is supported. **Note:** This is currently not supported with `v-combobox` [GitHub Issue](https://github.com/vuetifyjs/vuetify/issues/5479)", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "value", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "items", "description": "Can be an array of objects or array of strings. When using objects, will look for a text, value and disabled keys. This can be changed using the **item-text**, **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.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "menu-props", "description": "Pass props through to the `v-menu` component. Accepts either a string for boolean props `menu-props=\"auto, overflowY\"`, or an object `:menu-props=\"{ auto: true, overflowY: true }\"`", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "{\n closeOnClick: false,\n closeOnContentClick: false,\n disableKeys: true,\n openOnClick: false,\n maxHeight: 304\n}", "value": { "kind": "expression", "type": [ "string", "array", "object" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Changes select to multiple. Accepts array for value", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "no-data-text", "description": "Display text when there is no data", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "'$vuetify.noDataText'", "value": { "kind": "expression", "type": "string" } }, { "name": "no-filter", "description": "Do not apply filtering when searching. Useful when data is being filtered server side", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-clear", "description": "When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Applies the outlined style to the input", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-placeholder", "description": "Forces placeholder to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "placeholder", "description": "Sets the input's placeholder text", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prefix", "description": "Displays prefix text", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-inner-icon", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-object", "description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Reverses the input orientation", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the input", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "search-input", "description": "Use the **.sync** modifier to catch user input from the search input", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "shaped", "description": "Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-line", "description": "Label does not move on focus/dirty", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "small-chips", "description": "Changes display of selections to chips with the **small** property", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo", "description": "Changes the style of the input", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo-inverted", "description": "Reduces element opacity until focused", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "suffix", "description": "Displays suffix text", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "The comparison algorithm used for values. [More info](https://github.com/vuetifyjs/vuetify/blob/v2-stable/packages/vuetify/src/util/helpers.ts)", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#props", "default": "(a: any, b: any): boolean", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "blur", "description": "Emitted when the input is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:append-outer", "description": "Emitted when appended outer icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:clear", "description": "Emitted when clearable icon clicked", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend-inner", "description": "Emitted when prepended inner icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "focus", "description": "Emitted when component is focused", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "keydown", "description": "Emitted when **any** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:list-index", "description": "Emitted when menu item is selected using keyboard arrows", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:search-input", "description": "The `search-input.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "append-item", "description": "Adds an item after menu content", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "append-outer", "description": "Adds an item outside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "counter", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots", "vue-properties": [ { "name": "props", "type": "{\"dark\":\"boolean\",\"light\":\"boolean\",\"max\":\"string | number\",\"value\":\"string\"}" } ] }, { "name": "item", "description": "Define a custom item appearance", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "on", "type": "object // Only needed when providing your own v-list-item" }, { "name": "attrs", "type": "object // Only needed when providing your own v-list-item" } ] }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "no-data", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "prepend-inner", "description": "Adds an item inside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "prepend-item", "description": "Adds an item before menu content", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots" }, { "name": "selection", "description": "Define a custom selection appearance", "doc-url": "https://www.vuetifyjs.com/api/v-combobox#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "index", "type": "number" }, { "name": "select", "type": "function" }, { "name": "selected", "type": "boolean" }, { "name": "disabled", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDataIterator", "source": { "module": "./src/components/index.ts", "symbol": "VDataIterator" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator", "attributes": [ { "name": "checkbox-color", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "value": { "kind": "expression", "type": "string" } }, { "name": "custom-filter", "description": "Function to filter items", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "gh:searchItems", "value": { "kind": "expression", "type": "function" } }, { "name": "custom-group", "description": "Function used to group items", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "gh:groupItems", "value": { "kind": "expression", "type": "function" } }, { "name": "custom-sort", "description": "Function used to sort items", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "gh:sortItems", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-filtering", "description": "Disables filtering completely", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-pagination", "description": "Disables pagination completely", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-sort", "description": "Disables sorting completely", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "expanded", "description": "Array of expanded items. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "footer-props", "description": "See the [`v-data-footer`](/api/v-data-footer) API for more information", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "group-by", "description": "Changes which item property should be used for grouping items. Currently only supports a single grouping in the format: `group` or `['group']`. When using an array, only the first element is considered. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "group-desc", "description": "Changes which direction grouping is done. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "[]", "value": { "kind": "expression", "type": [ "boolean", "array" ] } }, { "name": "hide-default-footer", "description": "Hides default footer", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "item-key", "description": "The property on each item that is used as a unique key", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "'id'", "value": { "kind": "expression", "type": "string" } }, { "name": "items", "description": "The array of items to display", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "items-per-page", "description": "Changes how many items per page should be visible. Can be used with `.sync` modifier. Setting this prop to `-1` will display all items on the page", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "10", "value": { "kind": "expression", "type": "number" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loading", "description": "If `true` and no items are provided, then a loading text will be shown", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "loading-text", "description": "Text shown when `loading` is true and no items are provided", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "'$vuetify.dataIterator.loadingText'", "value": { "kind": "expression", "type": "string" } }, { "name": "locale", "description": "Sets the locale used for sorting. This is passed into [`Intl.Collator()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator) in the default `customSort` function", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "'en-US'", "value": { "kind": "expression", "type": "string" } }, { "name": "mobile-breakpoint", "description": "Used to set when to toggle between regular table and mobile view", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "600", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multi-sort", "description": "If `true` then one can sort on multiple properties", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "must-sort", "description": "If `true` then one can not disable sorting, it will always switch between ascending and descending", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "no-data-text", "description": "Text shown when no items are provided to the component", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "'$vuetify.noDataText'", "value": { "kind": "expression", "type": "string" } }, { "name": "no-results-text", "description": "Text shown when `search` prop is used and there are no results", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "'$vuetify.dataIterator.noResultsText'", "value": { "kind": "expression", "type": "string" } }, { "name": "options", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "{}", "value": { "kind": "expression", "type": "DataOptions" } }, { "name": "page", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "1", "value": { "kind": "expression", "type": "number" } }, { "name": "search", "description": "Text input used to filter items", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "selectable-key", "description": "The property on each item that is used to determine if it is selectable or not", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "'isSelectable'", "value": { "kind": "expression", "type": "string" } }, { "name": "server-items-length", "description": "Used only when data is provided by a server. Should be set to the total amount of items available on server so that pagination works correctly", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "-1", "value": { "kind": "expression", "type": "number" } }, { "name": "single-expand", "description": "Changes expansion mode to single expand", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-select", "description": "Changes selection mode to single select", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "sort-by", "description": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "sort-desc", "description": "Changes which direction sorting is done. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "array" ] } }, { "name": "value", "description": "Used for controlling selected rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#props", "default": "[]", "value": { "kind": "expression", "type": "array" } } ], "events": [ { "name": "current-items", "description": "Emits the items provided via the **items** prop, every time the internal **computedItems** is changed.", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "any[]" } ] }, { "name": "input", "description": "Array of selected items", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "any[]" } ] }, { "name": "item-expanded", "description": "Event emitted when an item is expanded or closed", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "{ item: any, value: boolean }" } ] }, { "name": "item-selected", "description": "Event emitted when an item is selected or deselected", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "{ item: any, value: boolean }" } ] }, { "name": "page-count", "description": "Emits when the **pageCount** property of the **pagination** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "pagination", "description": "Emits when something changed to the `pagination` which can be provided via the `pagination` prop", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" } ] }, { "name": "toggle-select-all", "description": "Emits when the `select-all` checkbox in table header is clicked. This checkbox is enabled by the **show-select** prop", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "{ items: any[], value: boolean }" } ] }, { "name": "update:expanded", "description": "The `.sync` event for `expanded` prop", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "any[]" } ] }, { "name": "update:group-by", "description": "Emits when the **group-by** property of the **options** property is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "string | string[]" } ] }, { "name": "update:group-desc", "description": "Emits when the **group-desc** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "boolean | boolean[]" } ] }, { "name": "update:items-per-page", "description": "Emits when the **items-per-page** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:multi-sort", "description": "Emits when the **multi-sort** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:must-sort", "description": "Emits when the **must-sort** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:options", "description": "Emits when one of the **options** properties is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" } ] }, { "name": "update:page", "description": "Emits when the **page** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:sort-by", "description": "Emits when the **sort-by** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "string | string[]" } ] }, { "name": "update:sort-desc", "description": "Emits when the **sort-desc** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#events", "arguments": [ { "name": "argument", "type": "boolean | boolean[]" } ] } ], "slots": [ { "name": "default", "description": "The default slot. Use this to render your items", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" }, { "name": "isSelected", "type": "(item: any) => boolean" }, { "name": "select", "type": "(item: any, value: boolean) => void" }, { "name": "isExpanded", "type": "(item: any) => boolean" }, { "name": "expand", "type": "(item: any, value: boolean) => void" } ] }, { "name": "footer", "description": "Defines a footer below the items", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" } ] }, { "name": "footer.page-text", "description": "This slot is forwarded to the default footer. See the [`v-data-footer`](/api/v-data-footer) API for more information", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots", "vue-properties": [ { "name": "pageStart", "type": "number" }, { "name": "pageStop", "type": "number" }, { "name": "itemsLength", "type": "number" } ] }, { "name": "header", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" } ] }, { "name": "item", "description": "Slot for each item", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots", "vue-properties": [ { "name": "expand", "type": "(v: boolean) => void" }, { "name": "index", "type": "number" }, { "name": "item", "type": "any" }, { "name": "isExpanded", "type": "boolean" }, { "name": "isMobile", "type": "boolean" }, { "name": "isSelected", "type": "boolean" }, { "name": "select", "type": "(v: boolean) => void" } ] }, { "name": "loading", "description": "Defines content for when `loading` is true and no items are provided", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots" }, { "name": "no-data", "description": "Defines content for when no items are provided", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots" }, { "name": "no-results", "description": "Defines content for when `search` is provided but no results are found", "doc-url": "https://www.vuetifyjs.com/api/v-data-iterator#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDataFooter", "source": { "module": "./src/components/index.ts", "symbol": "VDataFooter" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer", "attributes": [ { "name": "disable-items-per-page", "description": "Disables items-per-page dropdown", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-pagination", "description": "Disables pagination buttons", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "first-icon", "description": "First icon", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "'$first'", "value": { "kind": "expression", "type": "string" } }, { "name": "items-per-page-all-text", "description": "Text for 'All' option in items-per-page dropdown", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "'$vuetify.dataFooter.itemsPerPageAll'", "value": { "kind": "expression", "type": "string" } }, { "name": "items-per-page-options", "description": "Array of options to show in the items-per-page dropdown", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "[5,10,15,-1]", "value": { "kind": "expression", "type": "array" } }, { "name": "items-per-page-text", "description": "Text for items-per-page dropdown", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "'$vuetify.dataFooter.itemsPerPageText'", "value": { "kind": "expression", "type": "string" } }, { "name": "last-icon", "description": "Last icon", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "'$last'", "value": { "kind": "expression", "type": "string" } }, { "name": "next-icon", "description": "Next icon", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "'$next'", "value": { "kind": "expression", "type": "string" } }, { "name": "options", "description": "DataOptions", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "page-text", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "'$vuetify.dataFooter.pageText'", "value": { "kind": "expression", "type": "string" } }, { "name": "pagination", "description": "DataPagination", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "prev-icon", "description": "Previous icon", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "'$prev'", "value": { "kind": "expression", "type": "string" } }, { "name": "show-current-page", "description": "Show current page number between prev/next icons", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-first-last-page", "description": "Show first/last icons", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "update:options", "description": "The `.sync` event for `options` prop", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#events", "arguments": [ { "name": "argument", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" } ] } ], "slots": [ { "name": "page-text", "description": "Defines content for the items-per-page text", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#slots", "vue-properties": [ { "name": "pageStart", "type": "number" }, { "name": "pageStop", "type": "number" }, { "name": "itemsLength", "type": "number" } ] }, { "name": "prepend", "description": "Adds content to the empty space in the footer", "doc-url": "https://www.vuetifyjs.com/api/v-data-footer#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDataTable", "source": { "module": "./src/components/index.ts", "symbol": "VDataTable" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-table", "attributes": [ { "name": "calculate-widths", "description": "Enables calculation of column widths. `widths` property will be available in select scoped slots", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "caption", "description": "Set the caption (using ``)", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "checkbox-color", "description": "Set the color of the checkboxes (showSelect must be used)", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "custom-filter", "description": "Function to filter items", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "gh:defaultFilter", "value": { "kind": "expression", "type": "function" } }, { "name": "custom-group", "description": "Function used to group items", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "gh:groupItems", "value": { "kind": "expression", "type": "function" } }, { "name": "custom-sort", "description": "Function used to sort items", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "gh:sortItems", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Decreases the height of rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-filtering", "description": "Disables filtering completely", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-pagination", "description": "Disables pagination completely", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-sort", "description": "Disables sorting completely", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "expand-icon", "description": "Icon used for expand toggle button.", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'$expand'", "value": { "kind": "expression", "type": "string" } }, { "name": "expanded", "description": "Array of expanded items. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "filter-mode", "description": "Controls how how custom column filters are combined with the default filtering. Both modes only apply the default filter to columns not specified in `customKeyFilter`.\n\n- **union**: There is at least one match from the default filter, OR all custom column filters match.\n- **intersection**: There is at least one match from the default filter, AND all custom column filters match.", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'intersection'", "value": { "kind": "expression", "type": "string" } }, { "name": "fixed-header", "description": "Fixed header to top of table. **NOTE:** Does not work in IE11", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "footer-props", "description": "See the [`v-data-footer`](/api/v-data-footer) API for more information", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "group-by", "description": "Changes which item property should be used for grouping items. Currently only supports a single grouping in the format: `group` or `['group']`. When using an array, only the first element is considered. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "group-desc", "description": "Changes which direction grouping is done. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "[]", "value": { "kind": "expression", "type": [ "boolean", "array" ] } }, { "name": "header-props", "description": "Pass props to the default header. See [`v-data-table-header` API](/api/v-data-table-header) for more information", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "headers", "description": "An array of objects that each describe a header column. See the example below for a definition of all properties", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "[]", "value": { "kind": "expression", "type": "DataTableHeader[]" } }, { "name": "headers-length", "description": "Can be used in combination with `hide-default-header` to specify the number of columns in the table to allow expansion rows and loading bar to function properly", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": "number" } }, { "name": "height", "description": "Set an explicit height of table", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-default-footer", "description": "Hides default footer", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-default-header", "description": "Hide the default headers", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "item-class", "description": "Property on supplied `items` that contains item's row class or function that takes an item as an argument and returns the class of corresponding row", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "item-key", "description": "The property on each item that is used as a unique key", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'id'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-style", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "", "value": { "kind": "expression", "type": [ "string", "function" ] } }, { "name": "items", "description": "The array of items to display", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "items-per-page", "description": "Changes how many items per page should be visible. Can be used with `.sync` modifier. Setting this prop to `-1` will display all items on the page", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "10", "value": { "kind": "expression", "type": "number" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "4", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "loading", "description": "If `true` and no items are provided, then a loading text will be shown", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "loading-text", "description": "Text shown when `loading` is true and no items are provided", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'$vuetify.dataIterator.loadingText'", "value": { "kind": "expression", "type": "string" } }, { "name": "locale", "description": "Sets the locale used for sorting. This is passed into [`Intl.Collator()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator) in the default `customSort` function", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'en-US'", "value": { "kind": "expression", "type": "string" } }, { "name": "mobile-breakpoint", "description": "Used to set when to toggle between regular table and mobile view", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "600", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multi-sort", "description": "If `true` then one can sort on multiple properties", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "must-sort", "description": "If `true` then one can not disable sorting, it will always switch between ascending and descending", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "no-data-text", "description": "Text shown when no items are provided to the component", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'$vuetify.noDataText'", "value": { "kind": "expression", "type": "string" } }, { "name": "no-results-text", "description": "Text shown when `search` prop is used and there are no results", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'$vuetify.dataIterator.noResultsText'", "value": { "kind": "expression", "type": "string" } }, { "name": "options", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "{}", "value": { "kind": "expression", "type": "DataOptions" } }, { "name": "page", "description": "The current displayed page number (1-indexed)", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "1", "value": { "kind": "expression", "type": "number" } }, { "name": "search", "description": "Text input used to filter items", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "selectable-key", "description": "The property on each item that is used to determine if it is selectable or not", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "'isSelectable'", "value": { "kind": "expression", "type": "string" } }, { "name": "server-items-length", "description": "Used only when data is provided by a server. Should be set to the total amount of items available on server so that pagination works correctly", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "-1", "value": { "kind": "expression", "type": "number" } }, { "name": "show-expand", "description": "Shows the expand toggle in default rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-group-by", "description": "Shows the group by toggle in the header and enables grouped rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-select", "description": "Shows the select checkboxes in both the header and rows (if using default rows)", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-expand", "description": "Changes expansion mode to single expand", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-select", "description": "Changes selection mode to single select", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "sort-by", "description": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "sort-desc", "description": "Changes which direction sorting is done. Can be used with `.sync` modifier", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "array" ] } }, { "name": "value", "description": "Used for controlling selected rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#props", "default": "[]", "value": { "kind": "expression", "type": "array" } } ], "events": [ { "name": ":row", "description": "Pass through any native event listener to the table row elements. The first argument is the event object and the second is related data provided to the item slot. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "{\n expand: (value: boolean) => void,\n headers: DataTableHeader[],\n isExpanded: boolean,\n isMobile: boolean,\n isSelected: boolean,\n item: any,\n select: (value: boolean) => void\n}, Event" } ] }, { "name": "click:row", "description": "Emits when a table row is clicked. This event provides 3 arguments: the first is the item data that was clicked, the second is the other related data provided by the `item` slot, and the third is the native click event. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "any, {\n expand: (value: boolean) => void,\n headers: DataTableHeader[],\n isExpanded: boolean,\n isMobile: boolean,\n isSelected: boolean,\n item: any,\n select: (value: boolean) => void\n}, MouseEvent" } ] }, { "name": "current-items", "description": "Emits the items provided via the **items** prop, every time the internal **computedItems** is changed.", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "any[]" } ] }, { "name": "input", "description": "Array of selected items", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "any[]" } ] }, { "name": "item-expanded", "description": "Event emitted when an item is expanded or closed", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "{ item: any, value: boolean }" } ] }, { "name": "item-selected", "description": "Event emitted when an item is selected or deselected", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "{ item: any, value: boolean }" } ] }, { "name": "page-count", "description": "Emits when the **pageCount** property of the **pagination** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "pagination", "description": "Emits when something changed to the `pagination` which can be provided via the `pagination` prop", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" } ] }, { "name": "toggle-select-all", "description": "Emits when the `select-all` checkbox in table header is clicked. This checkbox is enabled by the **show-select** prop", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "{ items: any[], value: boolean }" } ] }, { "name": "update:expanded", "description": "The `.sync` event for `expanded` prop", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "any[]" } ] }, { "name": "update:group-by", "description": "Emits when the **group-by** property of the **options** property is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "string | string[]" } ] }, { "name": "update:group-desc", "description": "Emits when the **group-desc** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "boolean | boolean[]" } ] }, { "name": "update:items-per-page", "description": "Emits when the **items-per-page** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:multi-sort", "description": "Emits when the **multi-sort** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:must-sort", "description": "Emits when the **must-sort** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:options", "description": "Emits when one of the **options** properties is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" } ] }, { "name": "update:page", "description": "Emits when the **page** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:sort-by", "description": "Emits when the **sort-by** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "string | string[]" } ] }, { "name": "update:sort-desc", "description": "Emits when the **sort-desc** property of the **options** prop is updated", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#events", "arguments": [ { "name": "argument", "type": "boolean | boolean[]" } ] } ], "slots": [ { "name": "body", "description": "Slot to replace the default table ``", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "isMobile", "type": "boolean" }, { "name": "isSelected", "type": "(item: any) => boolean" }, { "name": "select", "type": "(item: any, value: boolean) => void" }, { "name": "isExpanded", "type": "(item: any) => boolean" }, { "name": "expand", "type": "(item: any, value: boolean) => void" } ] }, { "name": "body.append", "description": "Appends elements to the end of the default table ``", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "isMobile", "type": "boolean" }, { "name": "isSelected", "type": "(item: any) => boolean" }, { "name": "select", "type": "(item: any, value: boolean) => void" }, { "name": "isExpanded", "type": "(item: any) => boolean" }, { "name": "expand", "type": "(item: any, value: boolean) => void" } ] }, { "name": "body.prepend", "description": "Prepends elements to the start of the default table ``", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "isMobile", "type": "boolean" }, { "name": "isSelected", "type": "(item: any) => boolean" }, { "name": "select", "type": "(item: any, value: boolean) => void" }, { "name": "isExpanded", "type": "(item: any) => boolean" }, { "name": "expand", "type": "(item: any, value: boolean) => void" } ] }, { "name": "expanded-item", "description": "Slot to customize expanded rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "isMobile", "type": "boolean" }, { "name": "item", "type": "any" }, { "name": "headers", "type": "DataTableHeader[]" } ] }, { "name": "foot", "description": "Slot to add a `` element after the ``. Not to be confused with the `footer` slot", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" } ] }, { "name": "footer", "description": "Slot to add a custom footer", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "props", "type": "{\"options\":{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"},\"pagination\":{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"},\"itemsPerPageText\":\"string\"}" }, { "name": "on", "type": "{}" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "widths", "type": "[]" } ] }, { "name": "footer.page-text", "description": "Slot to customize footer page text", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "pageStart", "type": "number" }, { "name": "pageStop", "type": "number" }, { "name": "itemsLength", "type": "number" } ] }, { "name": "footer.prepend", "description": "Adds content to the empty space in the footer", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots" }, { "name": "group", "description": "Slot to replace the default rendering of grouped rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "group", "type": "string" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "isMobile", "type": "boolean" }, { "name": "items", "type": "any[]" }, { "name": "headers", "type": "DataTableHeader[]" } ] }, { "name": "group.header", "description": "Slot to customize the default rendering of group headers", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "group", "type": "string" }, { "name": "groupBy", "type": "string[]" }, { "name": "isMobile", "type": "boolean" }, { "name": "items", "type": "any[]" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "isOpen", "type": "boolean" }, { "name": "toggle", "type": "() => void" }, { "name": "remove", "type": "() => void" } ] }, { "name": "group.summary", "description": "Slot to customize the default rendering of group summaries", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "group", "type": "string" }, { "name": "groupBy", "type": "string[]" }, { "name": "isMobile", "type": "boolean" }, { "name": "items", "type": "any[]" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "isOpen", "type": "boolean" }, { "name": "toggle", "type": "() => void" } ] }, { "name": "header", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "isMobile", "type": "boolean" }, { "name": "props", "type": "{\"headers\":\"DataTableHeader[]\",\"options\":{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"},\"mobile\":\"boolean\",\"showGroupBy\":\"boolean\",\"someItems\":\"boolean\",\"everyItem\":\"boolean\"}" }, { "name": "on", "type": "{\"sort\":\"(value: string) => void\",\"group\":\"(value: string) => void\",\"toggle-select-all\":\"(value: boolean) => void\"}" } ] }, { "name": "header.", "pattern": { "items": "header-columns", "template": [ "header.", "#item:header column" ] }, "header-columns": { "name": "Header column", "pattern": { "regex": ".+" }, "doc-hide-pattern": true }, "description": "Slot to customize a specific header column", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "header", "type": "DataTableHeader" } ] }, { "name": "header.data-table-select", "description": "Slot to replace the default `v-simple-checkbox` in header", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "isMobile", "type": "boolean" }, { "name": "props", "type": "{\"value\":\"boolean\",\"indeterminate\":\"boolean\"}" }, { "name": "on", "type": "{\"input\":\"(value: boolean) => void\"}" } ] }, { "name": "item", "description": "Slot to replace the default rendering of a row", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "expand", "type": "(v: boolean) => void" }, { "name": "index", "type": "number" }, { "name": "item", "type": "any" }, { "name": "isExpanded", "type": "boolean" }, { "name": "isMobile", "type": "boolean" }, { "name": "isSelected", "type": "boolean" }, { "name": "select", "type": "(v: boolean) => void" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "on", "type": "{\"click\":\"(event: MouseEvent) => void\",\"contextmenu\":\"(event: MouseEvent) => void\",\"dblclick\":\"(event: MouseEvent) => void\"}" }, { "name": "attrs", "type": "{\"class\":\"object\"}" } ] }, { "name": "item.", "pattern": { "items": "columns", "template": [ "item.", "#item:column" ] }, "columns": { "name": "Column", "pattern": { "regex": ".+" }, "doc-hide-pattern": true }, "description": "Slot to customize a specific column", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "isMobile", "type": "boolean" }, { "name": "item", "type": "any" }, { "name": "header", "type": "DataTableHeader" }, { "name": "value", "type": "any" }, { "name": "index", "type": "number" } ] }, { "name": "item.data-table-expand", "description": "Slot to replace the default `v-icon` used when expanding rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "expand", "type": "(v: boolean) => void" }, { "name": "index", "type": "number" }, { "name": "item", "type": "any" }, { "name": "isExpanded", "type": "boolean" }, { "name": "isMobile", "type": "boolean" }, { "name": "isSelected", "type": "boolean" }, { "name": "select", "type": "(v: boolean) => void" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "on", "type": "{\"click\":\"(event: MouseEvent) => void\",\"contextmenu\":\"(event: MouseEvent) => void\",\"dblclick\":\"(event: MouseEvent) => void\"}" }, { "name": "attrs", "type": "{\"class\":\"object\"}" } ] }, { "name": "item.data-table-select", "description": "Slot to replace the default `v-simple-checkbox` used when selecting rows", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "expand", "type": "(v: boolean) => void" }, { "name": "index", "type": "number" }, { "name": "item", "type": "any" }, { "name": "isExpanded", "type": "boolean" }, { "name": "isMobile", "type": "boolean" }, { "name": "isSelected", "type": "boolean" }, { "name": "select", "type": "(v: boolean) => void" }, { "name": "headers", "type": "DataTableHeader[]" }, { "name": "on", "type": "{\"click\":\"(event: MouseEvent) => void\",\"contextmenu\":\"(event: MouseEvent) => void\",\"dblclick\":\"(event: MouseEvent) => void\"}" }, { "name": "attrs", "type": "{\"class\":\"object\"}" } ] }, { "name": "loading", "description": "Defines content for when `loading` is true and no items are provided", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots" }, { "name": "no-data", "description": "Defines content for when no items are provided", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots" }, { "name": "no-results", "description": "Defines content for when `search` is provided but no results are found", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots" }, { "name": "progress", "description": "Slot to replace the default `` component", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots" }, { "name": "top", "description": "Slot to add content above the table", "doc-url": "https://www.vuetifyjs.com/api/v-data-table#slots", "vue-properties": [ { "name": "items", "type": "any[]" }, { "name": "originalItemsLength", "type": "number" }, { "name": "pagination", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"pageStart\":\"number\",\"pageStop\":\"number\",\"pageCount\":\"number\",\"itemsLength\":\"number\"}" }, { "name": "options", "type": "{\"page\":\"number\",\"itemsPerPage\":\"number\",\"sortBy\":\"string[]\",\"sortDesc\":\"boolean[]\",\"groupBy\":\"string[]\",\"groupDesc\":\"boolean[]\",\"multiSort\":\"boolean\",\"mustSort\":\"boolean\"}" }, { "name": "groupedItems", "type": "Array<{ name: string, items: any[] }>" }, { "name": "updateOptions", "type": "(obj: any) => void" }, { "name": "sort", "type": "(value: string) => void" }, { "name": "sortArray", "type": "(sortBy: string[]) => void" }, { "name": "group", "type": "(value: string) => void" }, { "name": "isMobile", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VEditDialog", "source": { "module": "./src/components/index.ts", "symbol": "VEditDialog" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog", "attributes": [ { "name": "cancel-text", "description": "Sets the default text for the cancel button when using the **large** prop", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "Cancel", "value": { "kind": "expression", "type": "any" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "large", "description": "Attaches a submit and cancel button to the dialog", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent", "description": "Clicking outside or pressing **esc** key will not dismiss the dialog", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "save-text", "description": "Sets the default text for the save button when using the **large** prop", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "Save", "value": { "kind": "expression", "type": "any" } }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#props", "default": "'slide-x-reverse-transition'", "value": { "kind": "expression", "type": "string" } } ], "events": [ { "name": "cancel", "description": "Emits when editing is canceled", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "close", "description": "Emits when edit-dialog close button is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "open", "description": "Emits when editing is opened", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "save", "description": "Emits when edit-dialog save button is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#events", "arguments": [ { "name": "argument", "type": "void" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#slots" }, { "name": "input", "description": "Slot used to denote input component for v-edit-dialog", "doc-url": "https://www.vuetifyjs.com/api/v-edit-dialog#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDataTableHeader", "source": { "module": "./src/components/index.ts", "symbol": "VDataTableHeader" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header", "attributes": [ { "name": "checkbox-color", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "disable-sort", "description": "Toggles rendering of sort button", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "every-item", "description": "Indicates if all items in table are selected", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "headers", "description": "Array of header items to display", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "mobile", "description": "Renders mobile view of headers", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "options", "description": "Options object. Identical to the one on `v-data-table`", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "{\"page\":1,\"itemsPerPage\":10,\"sortBy\":[],\"sortDesc\":[],\"groupBy\":[],\"groupDesc\":[],\"multiSort\":false,\"mustSort\":false}", "value": { "kind": "expression", "type": "object" } }, { "name": "show-group-by", "description": "Shows group by button", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-select", "description": "Toggles rendering of select-all checkbox", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "some-items", "description": "Indicates if one or more items in table are selected", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "sort-by-text", "description": "Sets the label text used by the default sort-by selector when `v-data-table` is rendering the mobile view", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "'Sort by'", "value": { "kind": "expression", "type": "string" } }, { "name": "sort-icon", "description": "Icon used for sort button", "doc-url": "https://www.vuetifyjs.com/api/v-data-table-header#props", "default": "'$sort'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSimpleTable", "source": { "module": "./src/components/index.ts", "symbol": "VSimpleTable" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-simple-table", "attributes": [ { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-simple-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Decreases paddings to render a dense table", "doc-url": "https://www.vuetifyjs.com/api/v-simple-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed-header", "description": "Sets table header to fixed mode", "doc-url": "https://www.vuetifyjs.com/api/v-simple-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component", "doc-url": "https://www.vuetifyjs.com/api/v-simple-table#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-table#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-simple-table#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDatePicker", "source": { "module": "./src/components/index.ts", "symbol": "VDatePicker" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker", "attributes": [ { "name": "active-picker", "description": "Determines which picker in the date or month picker is being displayed. Allowed values: `'DATE'`, `'MONTH'`, `'YEAR'`", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "allowed-dates", "description": "Restricts which dates can be selected", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "day-format", "description": "Allows you to customize the format of the day string that appears in the date table. Called with date (ISO 8601 **date** string) arguments.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "disabled", "description": "Disables interaction with the picker", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "event-color", "description": "Sets the color for event dot. It can be string (all events will have the same color) or `object` where attribute is the event date and value is boolean/color/array of colors for specified date or `function` taking date as a parameter and returning boolean/color/array of colors for that date", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "warning", "value": { "kind": "expression", "type": [ "array", "function", "object", "string" ] } }, { "name": "events", "description": "Array of dates or object defining events or colors or function returning boolean/color/array of colors", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": [ "array", "function", "object" ] } }, { "name": "first-day-of-week", "description": "Sets the first day of the week, starting with 0 for Sunday.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "0", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "flat", "description": "Removes elevation", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Forces 100% width", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "header-color", "description": "Defines the header color. If not specified it will use the color defined by color prop or the default picker color", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "header-date-format", "description": "Allows you to customize the format of the month string that appears in the header of the calendar. Called with date (ISO 8601 **date** string) arguments.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "landscape", "description": "Orients picker horizontal", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "locale", "description": "Sets the locale. Accepts a string with a BCP 47 language tag.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "locale-first-day-of-year", "description": "Sets the day that determines the first week of the year, starting with 0 for **Sunday**. For ISO 8601 this should be 4.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "0", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "max", "description": "Maximum allowed date/month (ISO 8601 format)", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "min", "description": "Minimum allowed date/month (ISO 8601 format)", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "month-format", "description": "Formatting function used for displaying months in the months table. Called with date (ISO 8601 **date** string) arguments.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "multiple", "description": "Allow the selection of multiple dates", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "next-icon", "description": "Sets the icon for next month/year button", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'$next'", "value": { "kind": "expression", "type": "string" } }, { "name": "next-month-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'$vuetify.datePicker.nextMonthAriaLabel'", "value": { "kind": "expression", "type": "string" } }, { "name": "next-year-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'$vuetify.datePicker.nextYearAriaLabel'", "value": { "kind": "expression", "type": "string" } }, { "name": "no-title", "description": "Hide the picker title", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "picker-date", "description": "Displayed year/month", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prev-icon", "description": "Sets the icon for previous month/year button", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'$prev'", "value": { "kind": "expression", "type": "string" } }, { "name": "prev-month-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'$vuetify.datePicker.prevMonthAriaLabel'", "value": { "kind": "expression", "type": "string" } }, { "name": "prev-year-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'$vuetify.datePicker.prevYearAriaLabel'", "value": { "kind": "expression", "type": "string" } }, { "name": "range", "description": "Allow the selection of date range", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reactive", "description": "Updates the picker model when changing months/years automatically", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "readonly", "description": "Makes the picker readonly (doesn't allow to select new date)", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "scrollable", "description": "Allows changing displayed month with mouse scroll", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "selected-items-text", "description": "Text used for translating the number of selected dates when using *multiple* prop. Can also be customizing globally in [Internationalization](/customization/internationalization).", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'$vuetify.datePicker.itemsSelected'", "value": { "kind": "expression", "type": "string" } }, { "name": "show-adjacent-months", "description": "Toggles visibility of days from previous and next months", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-current", "description": "Toggles visibility of the current date/month outline or shows the provided date/month as a current", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "true", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "show-week", "description": "Toggles visibility of the week numbers in the body of the calendar", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "title-date-format", "description": "Allows you to customize the format of the date string that appears in the title of the date picker. Called with date (ISO 8601 **date** string) arguments.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "type", "description": "Determines the type of the picker - `date` for date picker, `month` for month picker", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "'date'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Date picker model (ISO 8601 format, YYYY-mm-dd or YYYY-mm)", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "array", "string" ] } }, { "name": "weekday-format", "description": "Allows you to customize the format of the weekday string that appears in the body of the calendar. Called with date (ISO 8601 **date** string) arguments.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "width", "description": "Width of the picker", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "290", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "year-format", "description": "Allows you to customize the format of the year string that appears in the header of the calendar. Called with date (ISO 8601 **date** string) arguments.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "year-icon", "description": "Sets the icon in the year selection button", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } } ], "events": [ { "name": ":date", "description": "Emitted when the specified DOM event occurs on the date button", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": ":month", "description": "Emitted when the specified DOM event occurs on the month button", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": ":year", "description": "Emitted when the specified DOM event occurs on the year button", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "change", "description": "Reactive date picker emits `input` even when any part of the date (year/month/day) changes, but `change` event is emitted only when the day (for date pickers) or month (for month pickers) changes. If `range` prop is set, date picker emits `change` when both [from, to] are selected.", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "update:active-picker", "description": "The `.sync` event for `active-picker` prop", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "update:picker-date", "description": "The `.sync` event for `picker-date` prop", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "default", "description": "Displayed below the calendar, can be used for example for adding action button (`OK` and `Cancel`)", "doc-url": "https://www.vuetifyjs.com/api/v-date-picker#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDialog", "source": { "module": "./src/components/index.ts", "symbol": "VDialog" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-dialog", "attributes": [ { "name": "activator", "description": "Designate a custom activator when the `activator` slot is not used. String can be any valid querySelector and Object can be any valid Node.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "close-delay", "description": "Milliseconds to wait before closing component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "content-class", "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.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the ability to open the component.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fullscreen", "description": "Changes layout for fullscreen display.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-overlay", "description": "Hides the display of the overlay.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "internal-activator", "description": "Detaches the menu content inside of the component as opposed to the document.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "no-click-animation", "description": "Disables the bounce effect when clicking outside of a `v-dialog`'s content when using the **persistent** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-delay", "description": "Milliseconds to wait before opening component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "open-on-click", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-focus", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "'center center'", "value": { "kind": "expression", "type": "string" } }, { "name": "overlay-color", "description": "Sets the overlay color.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "overlay-opacity", "description": "Sets the overlay opacity.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "persistent", "description": "Clicking outside of the element or pressing **esc** key will not deactivate it.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "retain-focus", "description": "Tab focus will return to the first child of the dialog by default. Disable this when using external tools that require focus such as TinyMCE or vue-clipboard.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "scrollable", "description": "When set to true, expects a `v-card` and a `v-card-text` component with a designated height. For more information, check out the [scrollable example](/components/dialogs#scrollable).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "dialog-transition", "value": { "kind": "expression", "type": [ "string", "boolean" ] } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } } ], "events": [ { "name": "click:outside", "description": "Event that fires when clicking outside an active dialog.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#events", "arguments": [ { "name": "argument", "type": "Boolean" } ] }, { "name": "keydown", "description": "Event that fires when key is pressed. If dialog is active and not using the **persistent** prop, the **esc** key will deactivate it.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] } ], "slots": [ { "name": "activator", "description": "When used, will activate the component when clicked (or hover for specific components). This manually stops the event propagation. Without this slot, if you open the component through its model, you will need to manually stop the event propagation", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#slots", "vue-properties": [ { "name": "on", "type": "{ [eventName]: eventHandler }" }, { "name": "value", "type": "boolean" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-dialog#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDivider", "source": { "module": "./src/components/index.ts", "symbol": "VDivider" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-divider", "attributes": [ { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-divider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "inset", "description": "Adds indentation (72px) for **normal** dividers, reduces max height for **vertical**.", "doc-url": "https://www.vuetifyjs.com/api/v-divider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-divider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "vertical", "description": "Displays dividers vertically", "doc-url": "https://www.vuetifyjs.com/api/v-divider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VExpansionPanels", "source": { "module": "./src/components/index.ts", "symbol": "VExpansionPanels" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels", "attributes": [ { "name": "accordion", "description": "Removes the margin around open panels", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "'v-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the entire expansion-panel", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Removes the expansion-panel's elevation and borders", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "focusable", "description": "Makes the expansion-panel headers focusable", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hover", "description": "Applies a background-color shift on hover to expansion panel headers", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "inset", "description": "Makes the expansion-panel open with a inset style", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "popout", "description": "Makes the expansion-panel open with an popout style", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "readonly", "description": "Makes the entire expansion-panel read only.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the border-radius", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "Controls the opened/closed state of content in the expansion-panel. Corresponds to a zero-based index of the currently opened content. If the `multiple` prop (previously `expand` in 1.5.x) is used then it is an array of numbers where each entry corresponds to the index of the opened content. The index order is not relevant.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panels#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VExpansionPanel", "source": { "module": "./src/components/index.ts", "symbol": "VExpansionPanel" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel#props", "value": { "kind": "expression", "type": "string" } }, { "name": "disabled", "description": "Disables the expansion-panel content", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "readonly", "description": "Makes the expansion-panel content read only.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "change", "description": "Toggles the value of the selected panel", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "click", "description": "Mouse click event", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] } ], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VExpansionPanelHeader", "source": { "module": "./src/components/index.ts", "symbol": "VExpansionPanelHeader" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "disable-icon-rotate", "description": "Removes the icon rotation animation when expanding a panel", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "expand-icon", "description": "Set the expand action icon", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#props", "default": "'$expand'", "value": { "kind": "expression", "type": "string" } }, { "name": "hide-actions", "description": "Hide the expand icon in the content header", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "object" ] } } ], "events": [ { "name": "click", "description": "Mouse click event", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] } ], "slots": [ { "name": "actions", "description": "Expansion header actions", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#slots", "vue-properties": [ { "name": "open", "type": "boolean" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-header#slots", "vue-properties": [ { "name": "open", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VExpansionPanelContent", "source": { "module": "./src/components/index.ts", "symbol": "VExpansionPanelContent" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-content", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-content#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-content#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-expansion-panel-content#slots", "vue-properties": [ { "name": "open", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VFileInput", "source": { "module": "./src/components/index.ts", "symbol": "VFileInput" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-file-input", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "append-outer-icon", "description": "Appends an icon to the outside the component's input, uses same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "autofocus", "description": "Enables autofocus", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "chips", "description": "Changes display of selections to chips", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clear-icon", "description": "Applied when using **clearable** and the input is dirty", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "'$clear'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Add input clear functionality, default icon is Material Design Icons **mdi-clear**", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "counter", "description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "counter-size-string", "description": "The text displayed when using the **counter** and **show-size** props. Can also be customized globally on the [internationalization page](/customization/internationalization).", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "'$vuetify.fileInput.counterSize'", "value": { "kind": "expression", "type": "string" } }, { "name": "counter-string", "description": "The text displayed when using the **counter** prop. Can also be customized globally on the [internationalization page](/customization/internationalization).", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "'$vuetify.fileInput.counter'", "value": { "kind": "expression", "type": "string" } }, { "name": "counter-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "filled", "description": "Applies the alternate filled input style", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Designates input type as full-width", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hide-input", "description": "Display the icon only without the input (file names)", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Adds the **multiple** attribute to the input, allowing multiple file selections.", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Applies the outlined style to the input", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-placeholder", "description": "Forces placeholder to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "placeholder", "description": "Sets the input's placeholder text", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prefix", "description": "Displays prefix text", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "'$file'", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-inner-icon", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "reverse", "description": "Reverses the input orientation", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the input", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "shaped", "description": "Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-size", "description": "Sets the displayed size of selected file(s). When using **true** will default to _1000_ displaying (**kB, MB, GB**) while _1024_ will display (**KiB, MiB, GiB**).", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "number" ] } }, { "name": "single-line", "description": "Label does not move on focus/dirty", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "small-chips", "description": "Changes display of selections to chips with the **small** property", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo", "description": "Changes the style of the input", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo-inverted", "description": "Reduces element opacity until focused", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "suffix", "description": "Displays suffix text", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "truncate-length", "description": "The length of a filename before it is truncated with ellipsis", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "22", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "A single or array of [File objects](https://developer.mozilla.org/en-US/docs/Web/API/File).", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#props", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "blur", "description": "Emitted when the input is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "File[]" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:append-outer", "description": "Emitted when appended outer icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:clear", "description": "Emitted when clearable icon clicked", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend-inner", "description": "Emitted when prepended inner icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "focus", "description": "Emitted when component is focused", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "keydown", "description": "Emitted when **any** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots" }, { "name": "append-outer", "description": "Adds an item outside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots" }, { "name": "counter", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots", "vue-properties": [ { "name": "props", "type": "{\"dark\":\"boolean\",\"light\":\"boolean\",\"max\":\"string | number\",\"value\":\"string\"}" } ] }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots" }, { "name": "prepend-inner", "description": "Adds an item inside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots" }, { "name": "selection", "description": "Slot for defining a custom appearance for selected item(s). Provides the current **index**, **text** (truncated) and [file](https://developer.mozilla.org/en-US/docs/Web/API/File).", "doc-url": "https://www.vuetifyjs.com/api/v-file-input#slots", "vue-properties": [ { "name": "file", "type": "File" }, { "name": "index", "type": "number" }, { "name": "multiple", "type": "boolean" }, { "name": "text", "type": "string" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VFooter", "source": { "module": "./src/components/index.ts", "symbol": "VFooter" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-footer", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "app", "description": "Designates the component as part of the application layout. Used for dynamically adjusting content sizing. Components using this prop should reside **outside** of `v-main` component to function properly. You can find more information about layouts on the [application page](/components/application). **Note:** this prop automatically applies **position: fixed** to the layout element. You can overwrite this functionality by using the `absolute` prop", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "auto", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "inset", "description": "Positions the toolbar offset from an application `v-navigation-drawer`", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "padless", "description": "Remove all padding from the footer", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "'footer'", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-footer#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VForm", "source": { "module": "./src/components/index.ts", "symbol": "VForm" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-form", "attributes": [ { "name": "disabled", "description": "Puts all children inputs into a disabled state.", "doc-url": "https://www.vuetifyjs.com/api/v-form#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "lazy-validation", "description": "If enabled, **value** will always be _true_ unless there are visible validation errors. You can still call `validate()` to manually trigger validation", "doc-url": "https://www.vuetifyjs.com/api/v-form#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "readonly", "description": "Puts all children inputs into a readonly state.", "doc-url": "https://www.vuetifyjs.com/api/v-form#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "A boolean value representing the validity of the form.", "doc-url": "https://www.vuetifyjs.com/api/v-form#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-form#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "submit", "description": "Emitted when form is submitted", "doc-url": "https://www.vuetifyjs.com/api/v-form#events", "arguments": [ { "name": "argument", "type": "event" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-form#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VContainer", "source": { "module": "./src/components/index.ts", "symbol": "VContainer" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-container", "attributes": [ { "name": "fluid", "description": "Removes viewport maximum-width size breakpoints", "doc-url": "https://www.vuetifyjs.com/api/v-container#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-container#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-container#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-container#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCol", "source": { "module": "./src/components/index.ts", "symbol": "VCol" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-col", "attributes": [ { "name": "align-self", "description": "Applies the [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) css property. Available options are **start**, **center**, **end**, **auto**, **baseline** and **stretch**.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "cols", "description": "Sets the default number of columns the component extends. Available options are **1 -> 12** and **auto**.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string", "number" ] } }, { "name": "lg", "description": "Changes the number of columns on large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string", "number" ] } }, { "name": "md", "description": "Changes the number of columns on medium and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string", "number" ] } }, { "name": "offset", "description": "Sets the default offset for the column.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "offset-lg", "description": "Changes the offset of the component on large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "offset-md", "description": "Changes the offset of the component on medium and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "offset-sm", "description": "Changes the offset of the component on small and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "offset-xl", "description": "Changes the offset of the component on extra large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "order", "description": "Sets the default [order](https://developer.mozilla.org/en-US/docs/Web/CSS/order) for the column.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "order-lg", "description": "Changes the order of the component on large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "order-md", "description": "Changes the order of the component on medium and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "order-sm", "description": "Changes the order of the component on small and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "order-xl", "description": "Changes the order of the component on extra large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "sm", "description": "Changes the number of columns on small and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string", "number" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "xl", "description": "Changes the number of columns on extra large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-col#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string", "number" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-col#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VRow", "source": { "module": "./src/components/index.ts", "symbol": "VRow" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-row", "attributes": [ { "name": "align", "description": "Applies the [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) css property. Available options are **start**, **center**, **end**, **baseline** and **stretch**.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-content", "description": "Applies the [align-content](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content) css property. Available options are **start**, **center**, **end**, **space-between**, **space-around** and **stretch**.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-content-lg", "description": "Changes the **align-content** property on large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-content-md", "description": "Changes the **align-content** property on medium and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-content-sm", "description": "Changes the **align-content** property on small and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-content-xl", "description": "Changes the **align-content** property on extra large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-lg", "description": "Changes the **align-items** property on large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-md", "description": "Changes the **align-items** property on medium and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-sm", "description": "Changes the **align-items** property on small and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-xl", "description": "Changes the **align-items** property on extra large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dense", "description": "Reduces the gutter between `v-col`s.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "justify", "description": "Applies the [justify-content](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content) css property. Available options are **start**, **center**, **end**, **space-between** and **space-around**.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "justify-lg", "description": "Changes the **justify-content** property on large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "justify-md", "description": "Changes the **justify-content** property on medium and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "justify-sm", "description": "Changes the **justify-content** property on small and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "justify-xl", "description": "Changes the **justify-content** property on extra large and greater breakpoints.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "no-gutters", "description": "Removes the gutter between `v-col`s.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-row#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-row#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSpacer", "source": { "module": "./src/components/index.ts", "symbol": "VSpacer" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-spacer", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-spacer#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-spacer#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VLayout", "source": { "module": "./src/components/index.ts", "symbol": "VLayout" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout", "attributes": [ { "name": "align-baseline", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-center", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-content-center", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-content-end", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-content-space-around", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-content-space-between", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-content-start", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-end", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "align-start", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "column", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "d-{type}", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "fill-height", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "justify-center", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "justify-end", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "justify-space-around", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "justify-space-between", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "justify-start", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "Boolean" } }, { "name": "reverse", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "row", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "div", "value": { "kind": "expression", "type": "String" } }, { "name": "wrap", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-layout#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-layout#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VFlex", "source": { "module": "./src/components/index.ts", "symbol": "VFlex" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex", "attributes": [ { "name": "(size)(1-12)", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "align-self-baseline", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "align-self-center", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "align-self-end", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "align-self-start", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "grow", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "offset-(size)(0-12)", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "order-(size)(1-12)", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "shrink", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-flex#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-flex#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VHover", "source": { "module": "./src/components/index.ts", "symbol": "VHover" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-hover", "attributes": [ { "name": "close-delay", "description": "Milliseconds to wait before closing component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-hover#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "disabled", "description": "Turns off hover functionality", "doc-url": "https://www.vuetifyjs.com/api/v-hover#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-delay", "description": "Milliseconds to wait before opening component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-hover#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-hover#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-hover#slots", "vue-properties": [ { "name": "hover", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VIcon", "source": { "module": "./src/components/index.ts", "symbol": "VIcon" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-icon", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Makes icon smaller (20px)", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "large", "description": "Makes the component large.", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "left", "description": "Applies appropriate margins to the icon inside of a button when placed to the **left** of another element or text", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "right", "description": "Applies appropriate margins to the icon inside of a button when placed to the **right** of another element or text", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "size", "description": "Specifies a custom font size for the icon", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "small", "description": "Makes the component small.", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specifies a custom tag to be used", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "'i'", "value": { "kind": "expression", "type": "string" } }, { "name": "x-large", "description": "Makes the component extra large.", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "x-small", "description": "Makes the component extra small.", "doc-url": "https://www.vuetifyjs.com/api/v-icon#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-icon#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VImg", "source": { "module": "./src/components/index.ts", "symbol": "VImg" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-img", "attributes": [ { "name": "alt", "description": "Alternate text for screen readers. Leave empty for decorative images", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "aspect-ratio", "description": "Calculated as `width/height`, so for a 1920x1080px image this will be `1.7778`. Will be calculated automatically if omitted", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "contain", "description": "Prevents the image from being cropped if it doesn't fit", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "content-class", "description": "Apply a custom class to the responsive content div.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "gradient", "description": "Overlays a gradient onto the image. Only supports [linear-gradient](https://developer.mozilla.org/en-US/docs/Web/CSS/linear-gradient) syntax, anything else should be done with classes (see examples)", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "lazy-src", "description": "Something to show while waiting for the main image to load, typically a small base64-encoded thumbnail. Has a slight blur filter applied.\n\nUse [vuetify-loader](https://github.com/vuetifyjs/vuetify-loader) to generate automatically", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "options", "description": "Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "{}", "value": { "kind": "expression", "type": "object" } }, { "name": "position", "description": "Overrides the default to change which parts get cropped off. Uses the same syntax as [`background-position`](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position)", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "'center center'", "value": { "kind": "expression", "type": "string" } }, { "name": "sizes", "description": "For use with `srcset`, see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "src", "description": "The image URL. This prop is mandatory", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "srcset", "description": "A set of alternate images to use based on device size. [Read more...](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset)", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "transition", "description": "The transition to use when switching from `lazy-src` to `src`", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "fade-transition", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-img#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "error", "description": "Emitted when there is an error", "doc-url": "https://www.vuetifyjs.com/api/v-img#events", "arguments": [ { "name": "argument", "type": "object | string" } ] }, { "name": "load", "description": "Emitted when image is loaded", "doc-url": "https://www.vuetifyjs.com/api/v-img#events", "arguments": [ { "name": "argument", "type": "object | string" } ] }, { "name": "loadstart", "description": "Emitted when the image starts to load", "doc-url": "https://www.vuetifyjs.com/api/v-img#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-img#slots" }, { "name": "placeholder", "description": "Slot for image placeholder", "doc-url": "https://www.vuetifyjs.com/api/v-img#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VInput", "source": { "module": "./src/components/index.ts", "symbol": "VInput" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-input", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hide-spin-buttons", "description": "Hides spin buttons on the input when type is set to `number`.", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-input#props", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-input#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-input#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-input#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-input#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-input#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-input#slots" }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-input#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-input#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VItem", "source": { "module": "./src/components/index.ts", "symbol": "VItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-item", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-item#props", "value": { "kind": "expression", "type": "string" } }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The value used when the component is selected in a group. If not provided, the index will be used.", "doc-url": "https://www.vuetifyjs.com/api/v-item#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-item#slots", "vue-properties": [ { "name": "active", "type": "boolean" }, { "name": "toggle", "type": "Function" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VItemGroup", "source": { "module": "./src/components/index.ts", "symbol": "VItemGroup" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-item-group", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "'v-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the component value is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-item-group#events", "arguments": [ { "name": "argument", "type": "any[] | any" } ] } ], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VLazy", "source": { "module": "./src/components/index.ts", "symbol": "VLazy" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-lazy", "attributes": [ { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "options", "description": "Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "{}", "value": { "kind": "expression", "type": "object" } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "'fade-transition'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-lazy#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemActionText", "source": { "module": "./src/components/index.ts", "symbol": "VListItemActionText" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-action-text", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-action-text#props", "default": "'span'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-action-text#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemContent", "source": { "module": "./src/components/index.ts", "symbol": "VListItemContent" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-content", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-content#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-content#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemTitle", "source": { "module": "./src/components/index.ts", "symbol": "VListItemTitle" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-title", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-title#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-title#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemSubtitle", "source": { "module": "./src/components/index.ts", "symbol": "VListItemSubtitle" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-subtitle", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-subtitle#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-subtitle#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VList", "source": { "module": "./src/components/index.ts", "symbol": "VList" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Lowers max height of list tiles", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables all children `v-list-item` components", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "expand", "description": "Will only collapse when explicitly closed", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Remove the highlighted background on active `v-list-item`s", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nav", "description": "An alternative styling that reduces `v-list-item` width and rounds the corners. Typically used with **[v-navigation-drawer](/components/navigation-drawers)**", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Rounds the `v-list-item` edges", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "shaped", "description": "Provides an alternative active style for `v-list-item`.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "subheader", "description": "Removes top padding. Used when previous sibling is a header", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "three-line", "description": "Increases list-item height for three lines. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "two-line", "description": "Increases list-item height for two lines. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListGroup", "source": { "module": "./src/components/index.ts", "symbol": "VListGroup" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-group", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "'$expand'", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "disabled", "description": "Disables all children `v-list-item` components", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "group", "description": "Assign a route namespace. Accepts a string or regexp for determining active state", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "regexp" ] } }, { "name": "no-action", "description": "Removes left padding assigned for action icons from group items", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "true", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "sub-group", "description": "Designate the component as nested list group", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "Expands / Collapse the list-group", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "click", "description": "Event that is emitted when the component is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] } ], "slots": [ { "name": "activator", "description": "When used, will activate the component when clicked (or hover for specific components). This manually stops the event propagation. Without this slot, if you open the component through its model, you will need to manually stop the event propagation", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#slots" }, { "name": "appendIcon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#slots" }, { "name": "prependIcon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-list-group#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItem", "source": { "module": "./src/components/index.ts", "symbol": "VListItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "", "value": { "kind": "expression", "type": "string" } }, { "name": "append", "description": "Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control when in an **active** state or **input-value** is **true** - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`)", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Lowers max height of list tiles", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the component", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "exact-active-class", "description": "Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "exact-path", "description": "Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "href", "description": "Designates the component as anchor and applies the **href** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "inactive", "description": "If set, the list tile will not be rendered as a link even if it has to/href prop or @click handler", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "input-value", "description": "Controls the **active** state of the item. This is typically used to highlight the component", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "link", "description": "Designates that the component is a link. This is automatic when using the **href** or **to** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "nuxt", "description": "Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "selectable", "description": "Allow text selection inside `v-list-item`. This prop uses [user-select](https://developer.mozilla.org/en-US/docs/Web/CSS/user-select)", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "target", "description": "Designates the target attribute. This should only be applied when using the **href** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "three-line", "description": "Increases list-item height for three lines. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "two-line", "description": "Increases list-item height for two lines. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The value used when a child of a [v-list-item-group](/components/list-item-groups).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "click", "description": "Event that is emitted when the component is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#events", "arguments": [ { "name": "argument", "type": "MouseEvent | KeyboardEvent" } ] }, { "name": "keydown", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item#slots", "vue-properties": [ { "name": "active", "type": "boolean" }, { "name": "toggle", "type": "Function" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemAction", "source": { "module": "./src/components/index.ts", "symbol": "VListItemAction" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-action", "attributes": [], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-action#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemAvatar", "source": { "module": "./src/components/index.ts", "symbol": "VListItemAvatar" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "horizontal", "description": "Uses an alternative horizontal style.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "left", "description": "Designates that the avatar is on the left side of a component. This is hooked into by components such as [v-chip](/components/chips) and [v-btn](/components/buttons).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "right", "description": "Designates that the avatar is on the right side of a component. This is hooked into by components such as [v-chip](/components/chips) and [v-btn](/components/buttons).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "size", "description": "Sets the height and width of the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "40", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-avatar#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemIcon", "source": { "module": "./src/components/index.ts", "symbol": "VListItemIcon" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-icon", "attributes": [], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-icon#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VListItemGroup", "source": { "module": "./src/components/index.ts", "symbol": "VListItemGroup" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "'v-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Sets the active list-item inside the list-group", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the component value is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#events", "arguments": [ { "name": "argument", "type": "any[] | any" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-list-item-group#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VMain", "source": { "module": "./src/components/index.ts", "symbol": "VMain" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-main", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-main#props", "default": "'main'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VMenu", "source": { "module": "./src/components/index.ts", "symbol": "VMenu" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-menu", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "activator", "description": "Designate a custom activator when the `activator` slot is not used. String can be any valid querySelector and Object can be any valid Node.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "allow-overflow", "description": "Removes overflow re-positioning for the content", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "auto", "description": "Centers list on selected element", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "close-delay", "description": "Milliseconds to wait before closing component. Only works with the **open-on-hover** prop", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "close-on-click", "description": "Designates if menu should close on outside-activator click", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "close-on-content-click", "description": "Designates if menu should close when its content is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "content-class", "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.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "content-props", "description": "Applies props/attributes to the detached menu. 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. You could use this for example for applying a `data-cy` for cypress testing purposes.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "{}", "value": { "kind": "expression", "type": "object" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-keys", "description": "Removes all keyboard interaction", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the menu", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "internal-activator", "description": "Detaches the menu content inside of the component as opposed to the document.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "left", "description": "Aligns the component towards the left.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the max height of the menu content", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "auto", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the content", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "auto", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the content", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-bottom", "description": "Nudge the content to the bottom", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-left", "description": "Nudge the content to the left", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-right", "description": "Nudge the content to the right", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-top", "description": "Nudge the content to the top", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-width", "description": "Nudge the content width", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "offset-overflow", "description": "Causes the component to flip to the opposite side when repositioned due to overflow", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "offset-x", "description": "Offset the menu on the x-axis. Works in conjunction with direction left/right", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "offset-y", "description": "Offset the menu on the y-axis. Works in conjunction with direction top/bottom", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-delay", "description": "Milliseconds to wait before opening component. Only works with the **open-on-hover** prop", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "open-on-click", "description": "Designates whether menu should open on activator click", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-focus", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-hover", "description": "Designates whether menu should open on activator hover", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "'top left'", "value": { "kind": "expression", "type": "string" } }, { "name": "position-x", "description": "Used to position the content when not using an activator slot", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": "number" } }, { "name": "position-y", "description": "Used to position the content when not using an activator slot", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": "number" } }, { "name": "return-value", "description": "The value that is updated when the menu is closed - must be primitive. Dot notation is supported", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "right", "description": "Aligns the component towards the right.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "top", "description": "Aligns the content towards the top.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "v-menu-transition", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "z-index", "description": "The z-index used for the component", "doc-url": "https://www.vuetifyjs.com/api/v-menu#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-menu#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "activator", "description": "When used, will activate the component when clicked (or hover for specific components). This manually stops the event propagation. Without this slot, if you open the component through its model, you will need to manually stop the event propagation", "doc-url": "https://www.vuetifyjs.com/api/v-menu#slots", "vue-properties": [ { "name": "attrs", "type": "{ role: string, aria-haspopup: boolean, aria-expanded: string }" }, { "name": "on", "type": "{ [eventName]: eventHandler }" }, { "name": "value", "type": "boolean" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-menu#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VNavigationDrawer", "source": { "module": "./src/components/index.ts", "symbol": "VNavigationDrawer" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "app", "description": "Designates the component as part of the application layout. Used for dynamically adjusting content sizing. Components using this prop should reside **outside** of `v-main` component to function properly. You can find more information about layouts on the [application page](/components/application). **Note:** this prop automatically applies **position: fixed** to the layout element. You can overwrite this functionality by using the `absolute` prop", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Expands from the bottom of the screen on mobile devices", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clipped", "description": "A clipped drawer rests under the application toolbar. **Note:** requires the **clipped-left** or **clipped-right** prop on `v-app-bar` to work as intended", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-resize-watcher", "description": "Will automatically open/close drawer when resized depending if mobile or desktop.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-route-watcher", "description": "Disables opening of navigation drawer when route changes", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "expand-on-hover", "description": "Collapses the drawer to a **mini-variant** until hovering with the mouse", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "floating", "description": "A floating drawer has no visible container (no border-right)", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the navigation drawer", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "100%", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-overlay", "description": "Hides the display of the overlay.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mini-variant", "description": "Condenses navigation drawer width, also accepts the **.sync** modifier. With this, the drawer will re-open when clicking it", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mini-variant-width", "description": "Designates the width assigned when the `mini` prop is turned on", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "56", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "mobile-breakpoint", "description": "Sets the designated mobile breakpoint for the component. This will apply alternate styles for mobile devices such as the `temporary` prop, or activate the `bottom` prop when the breakpoint value is met. Setting the value to `0` will disable this functionality.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "overlay-color", "description": "Sets the overlay color.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "overlay-opacity", "description": "Sets the overlay opacity.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "permanent", "description": "The drawer remains visible regardless of screen size", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "right", "description": "Places the navigation drawer on the right", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "src", "description": "Specifies a [v-img](/components/images) as the component's background.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "stateless", "description": "Remove all automated state functionality (resize, mobile, route) and manually control the drawer state", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "'aside'", "value": { "kind": "expression", "type": "string" } }, { "name": "temporary", "description": "A temporary drawer sits above its application and uses a scrim (overlay) to darken the background", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "touchless", "description": "Disable mobile touch functionality", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#props", "default": "256", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "transitionend", "description": "Emits event object when transition is complete.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#events", "arguments": [ { "name": "argument", "type": "object" } ] }, { "name": "update:mini-variant", "description": "The `mini-variant.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "A slot at the bottom of the drawer", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#slots" }, { "name": "img", "description": "Used to modify `v-img` properties when using the **src** prop", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#slots", "vue-properties": [ { "name": "height", "type": "string" }, { "name": "src", "type": "string | srcObject" } ] }, { "name": "prepend", "description": "A slot at the top of the drawer", "doc-url": "https://www.vuetifyjs.com/api/v-navigation-drawer#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VOtpInput", "source": { "module": "./src/components/index.ts", "symbol": "VOtpInput" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input", "attributes": [ { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "length", "description": "The OTP field's length", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "6", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "plain", "description": "Outlined style applied by default to the input, set to `true` to apply plain style", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "type", "description": "Supported types: `text`, `password`, `number`", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "'text'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "finish", "description": "Emitted when the input is filled completely and cursor is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-otp-input#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VOverflowBtn", "source": { "module": "./src/components/index.ts", "symbol": "VOverflowBtn" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "'$dropdown'", "value": { "kind": "expression", "type": "string" } }, { "name": "append-outer-icon", "description": "Appends an icon to the outside the component's input, uses same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "auto-select-first", "description": "When searching, will always highlight the first option", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "autofocus", "description": "Enables autofocus", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "cache-items", "description": "Keeps a local _unique_ copy of all items that have been passed through the **items** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "chips", "description": "Changes display of selections to chips", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clear-icon", "description": "Applied when using **clearable** and the input is dirty", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "'$clear'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Add input clear functionality, default icon is Material Design Icons **mdi-clear**", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "counter", "description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "counter-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "deletable-chips", "description": "Adds a remove icon to selected chips", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-lookup", "description": "Disables keyboard lookup", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the input", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "editable", "description": "Creates an editable button", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "filled", "description": "Applies the alternate filled input style", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "filter", "description": "The function used for filtering items", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "(item, queryText, itemText) => {}", "value": { "kind": "expression", "type": "function" } }, { "name": "flat", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Designates input type as full-width", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hide-no-data", "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.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-selected", "description": "Do not display in the select menu items that are already selected. Also removes checkboxes from the list when multiple", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "item-color", "description": "Sets color of selected items", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-disabled", "description": "Set property of **items**'s disabled value", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "disabled", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-text", "description": "Set property of **items**'s text value", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "text", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-value", "description": "Set property of **items**'s value - **must be primitive**. Dot notation is supported. **Note:** This is currently not supported with `v-combobox` [GitHub Issue](https://github.com/vuetifyjs/vuetify/issues/5479)", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "value", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "items", "description": "Can be an array of objects or array of strings. When using objects, will look for a text, value and disabled keys. This can be changed using the **item-text**, **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.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "menu-props", "description": "Pass props through to the `v-menu` component. Accepts either a string for boolean props `menu-props=\"auto, overflowY\"`, or an object `:menu-props=\"{ auto: true, overflowY: true }\"`", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "{\n closeOnClick: false,\n closeOnContentClick: false,\n disableKeys: true,\n openOnClick: false,\n maxHeight: 304\n}", "value": { "kind": "expression", "type": [ "string", "array", "object" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Changes select to multiple. Accepts array for value", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "no-data-text", "description": "Display text when there is no data", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "'$vuetify.noDataText'", "value": { "kind": "expression", "type": "string" } }, { "name": "no-filter", "description": "Do not apply filtering when searching. Useful when data is being filtered server side", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-clear", "description": "When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Applies the outlined style to the input", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-placeholder", "description": "Forces label to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "placeholder", "description": "Sets the input's placeholder text", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prefix", "description": "Displays prefix text", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-inner-icon", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-object", "description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Reverses the input orientation", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the input", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "search-input", "description": "Use the **.sync** modifier to catch user input from the search input", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "segmented", "description": "Creates a segmented button", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "shaped", "description": "Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-line", "description": "Label does not move on focus/dirty", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "small-chips", "description": "Changes display of selections to chips with the **small** property", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo", "description": "Changes the style of the input", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo-inverted", "description": "Reduces element opacity until focused", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "suffix", "description": "Displays suffix text", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "The comparison algorithm used for values. [More info](https://github.com/vuetifyjs/vuetify/blob/v2-stable/packages/vuetify/src/util/helpers.ts)", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#props", "default": "(a: any, b: any): boolean", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "blur", "description": "Emitted when the input is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:append-outer", "description": "Emitted when appended outer icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:clear", "description": "Emitted when clearable icon clicked", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend-inner", "description": "Emitted when prepended inner icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "focus", "description": "Emitted when component is focused", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "keydown", "description": "Emitted when **any** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:list-index", "description": "Emitted when menu item is selected using keyboard arrows", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:search-input", "description": "The `search-input.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "append-item", "description": "Adds an item after menu content", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "append-outer", "description": "Adds an item outside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "counter", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots", "vue-properties": [ { "name": "props", "type": "{\"dark\":\"boolean\",\"light\":\"boolean\",\"max\":\"string | number\",\"value\":\"string\"}" } ] }, { "name": "item", "description": "Define a custom item appearance", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "on", "type": "object // Only needed when providing your own v-list-item" }, { "name": "attrs", "type": "object // Only needed when providing your own v-list-item" } ] }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "no-data", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "prepend-inner", "description": "Adds an item inside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "prepend-item", "description": "Adds an item before menu content", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots" }, { "name": "selection", "description": "Define a custom selection appearance", "doc-url": "https://www.vuetifyjs.com/api/v-overflow-btn#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "index", "type": "number" }, { "name": "select", "type": "function" }, { "name": "selected", "type": "boolean" }, { "name": "disabled", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VOverlay", "source": { "module": "./src/components/index.ts", "symbol": "VOverlay" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-overlay", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#props", "default": "'#212121'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "opacity", "description": "Sets the overlay opacity", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#props", "default": "0.46", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#props", "default": "true", "value": { "kind": "expression", "type": "any" } }, { "name": "z-index", "description": "The z-index used for the component", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#props", "default": "5", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-overlay#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VPagination", "source": { "module": "./src/components/index.ts", "symbol": "VPagination" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination", "attributes": [ { "name": "circle", "description": "Shape pagination elements as circles", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "current-page-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "'$vuetify.pagination.ariaLabel.currentPage'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables component", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "length", "description": "The length of the pagination component", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "0", "value": { "kind": "expression", "type": "number" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "navigation-color", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "navigation-text-color", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "next-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "'$vuetify.pagination.ariaLabel.next'", "value": { "kind": "expression", "type": "string" } }, { "name": "next-icon", "description": "Specify the icon to use for the next icon", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "'$next'", "value": { "kind": "expression", "type": "string" } }, { "name": "page-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "'$vuetify.pagination.ariaLabel.page'", "value": { "kind": "expression", "type": "string" } }, { "name": "prev-icon", "description": "Specify the icon to use for the prev icon", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "'$prev'", "value": { "kind": "expression", "type": "string" } }, { "name": "previous-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "'$vuetify.pagination.ariaLabel.previous'", "value": { "kind": "expression", "type": "string" } }, { "name": "total-visible", "description": "Specify the max total visible pagination numbers", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "value", "description": "Current selected page", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "0", "value": { "kind": "expression", "type": "number" } }, { "name": "wrapper-aria-label", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#props", "default": "'$vuetify.pagination.ariaLabel.wrapper'", "value": { "kind": "expression", "type": "string" } } ], "events": [ { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "next", "description": "Emitted when going to next item", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "previous", "description": "Emitted when going to previous item", "doc-url": "https://www.vuetifyjs.com/api/v-pagination#events", "arguments": [ { "name": "argument", "type": "void" } ] } ], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSheet", "source": { "module": "./src/components/index.ts", "symbol": "VSheet" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-sheet", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "div", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-sheet#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VParallax", "source": { "module": "./src/components/index.ts", "symbol": "VParallax" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-parallax", "attributes": [ { "name": "alt", "description": "Attaches an alt property to the parallax image", "doc-url": "https://www.vuetifyjs.com/api/v-parallax#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "height", "description": "Sets the height for the component", "doc-url": "https://www.vuetifyjs.com/api/v-parallax#props", "default": "500", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "src", "description": "The image to parallax", "doc-url": "https://www.vuetifyjs.com/api/v-parallax#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "srcset", "description": "A set of alternate images to use based on device size. [Read more...](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset)", "doc-url": "https://www.vuetifyjs.com/api/v-parallax#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-parallax#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VProgressCircular", "source": { "module": "./src/components/index.ts", "symbol": "VProgressCircular" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular", "attributes": [ { "name": "button", "description": "Deprecated - Pending removal", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "indeterminate", "description": "Constantly animates, use when loading progress is unknown.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rotate", "description": "Rotates the circle start point in deg", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "size", "description": "Sets the diameter of the circle in pixels", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#props", "default": "32", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "value", "description": "The percentage value for current progress", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "width", "description": "Sets the stroke of the circle in pixels", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#props", "default": "4", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-circular#slots", "vue-properties": [ { "name": "value", "type": "number" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VProgressLinear", "source": { "module": "./src/components/index.ts", "symbol": "VProgressLinear" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "active", "description": "Reduce the height to 0, hiding component", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Background color, set to component's color if null", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "background-opacity", "description": "Background opacity, if null it defaults to 0.3 if background color is not specified or 1 otherwise", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "buffer-value", "description": "The percentage value for the buffer", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "100", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "4", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "indeterminate", "description": "Constantly animates, use when loading progress is unknown.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "query", "description": "Animates like **indeterminate** prop but inverse", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Displays reversed progress (right to left in LTR mode and left to right in RTL)", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the progress component", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "stream", "description": "An alternative style for portraying loading that works in tandem with **buffer-value**", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "striped", "description": "Adds a stripe background to the filled portion of the progress component", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "top", "description": "Aligns the content towards the top.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "change", "description": "Emitted when the component value is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#events", "arguments": [ { "name": "argument", "type": "number" } ] } ], "slots": [ { "name": "default", "description": "Provides the current value of the component", "doc-url": "https://www.vuetifyjs.com/api/v-progress-linear#slots", "vue-properties": [ { "name": "value", "type": "number" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VRadioGroup", "source": { "module": "./src/components/index.ts", "symbol": "VRadioGroup" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "'v-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "column", "description": "Displays radio buttons in column", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "name", "description": "Sets the component's name attribute", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "row", "description": "Displays radio buttons in row", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#slots" }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-radio-group#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VRadio", "source": { "module": "./src/components/index.ts", "symbol": "VRadio" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-radio", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "name", "description": "Sets the component's name attribute", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "off-icon", "description": "The icon used when inactive", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "'$radioOff'", "value": { "kind": "expression", "type": "string" } }, { "name": "on-icon", "description": "The icon used when active", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "'$radioOn'", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "default": "true", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "value", "description": "The value used when the component is selected in a group. If not provided, the index will be used.", "doc-url": "https://www.vuetifyjs.com/api/v-radio#props", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-radio#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked. **Note:** the **change** event should be used instead of **click** when monitoring state change", "doc-url": "https://www.vuetifyjs.com/api/v-radio#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-radio#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-radio#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-radio#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-radio#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-radio#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-radio#slots" }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-radio#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-radio#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VRangeSlider", "source": { "module": "./src/components/index.ts", "symbol": "VRangeSlider" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "inverse-label", "description": "Reverse the label position. Works with **rtl**.", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "max", "description": "Sets the maximum allowed value", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "100", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "min", "description": "Sets the minimum allowed value", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "step", "description": "If greater than 0, sets step interval for ticks", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "thumb-color", "description": "Sets the thumb and thumb label color", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "thumb-label", "description": "Show thumb label. If `true` it shows label when using slider. If set to `'always'` it always shows label.", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "thumb-size", "description": "Controls the size of the thumb label.", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "32", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "tick-labels", "description": "When provided with Array, will attempt to map the labels to each step in index order", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "tick-size", "description": "Controls the size of **ticks**", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "ticks", "description": "Show track ticks. If `true` it shows ticks when using slider. If set to `'always'` it always shows ticks.", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "track-color", "description": "Sets the track's color", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "track-fill-color", "description": "Sets the track's fill color", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "value": { "kind": "expression", "type": "any" } }, { "name": "vertical", "description": "Changes slider direction to vertical", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "array" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "end", "description": "Slider value emitted at the end of slider movement", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "array" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "array" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "start", "description": "Slider value emitted at start of slider movement", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "array" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#slots" }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#slots" }, { "name": "thumb-label", "description": "Replaces the content inside the thumb label", "doc-url": "https://www.vuetifyjs.com/api/v-range-slider#slots", "vue-properties": [ { "name": "value", "type": "number | string" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VRating", "source": { "module": "./src/components/index.ts", "symbol": "VRating" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-rating", "attributes": [ { "name": "background-color", "description": "The color used for empty icons", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "'accent'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Allows for the component to be cleared. Triggers when the icon containing the current value is clicked.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "close-delay", "description": "Milliseconds to wait before closing component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Icons have a smaller size", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "empty-icon", "description": "The icon displayed when empty", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "'$ratingEmpty'", "value": { "kind": "expression", "type": "string" } }, { "name": "full-icon", "description": "The icon displayed when full", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "'$ratingFull'", "value": { "kind": "expression", "type": "string" } }, { "name": "half-icon", "description": "The icon displayed when half (requires **half-increments** prop)", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "'$ratingHalf'", "value": { "kind": "expression", "type": "string" } }, { "name": "half-increments", "description": "Allows the selection of half increments", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hover", "description": "Provides visual feedback when hovering over icons", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "icon-label", "description": "The **aria-label** used for icons", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "'$vuetify.rating.ariaLabel.icon'", "value": { "kind": "expression", "type": "string" } }, { "name": "large", "description": "Makes the component large.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "length", "description": "The amount of ratings to show", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "5", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-delay", "description": "Milliseconds to wait before opening component. Only applies to hover and focus events.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "readonly", "description": "Removes all hover effects and pointer events", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "true", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "size", "description": "Sets the height and width of the component.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "small", "description": "Makes the component small.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The rating value", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "0", "value": { "kind": "expression", "type": "number" } }, { "name": "x-large", "description": "Makes the component extra large.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "x-small", "description": "Makes the component extra small.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "input", "description": "Emits the rating number when this value changes", "doc-url": "https://www.vuetifyjs.com/api/v-rating#events", "arguments": [ { "name": "argument", "type": "Number" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-rating#slots" }, { "name": "item", "description": "The slot for rendered items", "doc-url": "https://www.vuetifyjs.com/api/v-rating#slots", "vue-properties": [ { "name": "click", "type": "(i: number) => void" }, { "name": "index", "type": "number" }, { "name": "isFilled", "type": "boolean" }, { "name": "isHalfFilled", "type": "?boolean" }, { "name": "isHalfHovered", "type": "?boolean" }, { "name": "isHovered", "type": "boolean" }, { "name": "value", "type": "number" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VResponsive", "source": { "module": "./src/components/index.ts", "symbol": "VResponsive" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-responsive", "attributes": [ { "name": "aspect-ratio", "description": "Sets a base aspect ratio, calculated as width/height. This will only set a **minimum** height, the component can still grow if it has a lot of content.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "content-class", "description": "Apply a custom class to the responsive content div.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-responsive#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSelect", "source": { "module": "./src/components/index.ts", "symbol": "VSelect" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-select", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "'$dropdown'", "value": { "kind": "expression", "type": "string" } }, { "name": "append-outer-icon", "description": "Appends an icon to the outside the component's input, uses same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "autofocus", "description": "Enables autofocus", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "cache-items", "description": "Keeps a local _unique_ copy of all items that have been passed through the **items** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "chips", "description": "Changes display of selections to chips", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "clear-icon", "description": "Applied when using **clearable** and the input is dirty", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "'$clear'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Add input clear functionality, default icon is Material Design Icons **mdi-clear**", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "counter", "description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "counter-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "deletable-chips", "description": "Adds a remove icon to selected chips", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-lookup", "description": "Disables keyboard lookup", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables the input", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "filled", "description": "Applies the alternate filled input style", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Designates input type as full-width", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hide-selected", "description": "Do not display in the select menu items that are already selected. Also removes checkboxes from the list when multiple", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "item-color", "description": "Sets color of selected items", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-disabled", "description": "Set property of **items**'s disabled value", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "disabled", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-text", "description": "Set property of **items**'s text value", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "text", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "item-value", "description": "Set property of **items**'s value - **must be primitive**. Dot notation is supported. **Note:** This is currently not supported with `v-combobox` [GitHub Issue](https://github.com/vuetifyjs/vuetify/issues/5479)", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "value", "value": { "kind": "expression", "type": [ "string", "array", "function" ] } }, { "name": "items", "description": "Can be an array of objects or array of strings. When using objects, will look for a text, value and disabled keys. This can be changed using the **item-text**, **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.", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "menu-props", "description": "Pass props through to the `v-menu` component. Accepts either a string for boolean props `menu-props=\"auto, overflowY\"`, or an object `:menu-props=\"{ auto: true, overflowY: true }\"`", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "{\n closeOnClick: false,\n closeOnContentClick: false,\n disableKeys: true,\n openOnClick: false,\n maxHeight: 304\n}", "value": { "kind": "expression", "type": [ "string", "array", "object" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Changes select to multiple. Accepts array for value", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "no-data-text", "description": "Display text when there is no data", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "'$vuetify.noDataText'", "value": { "kind": "expression", "type": "string" } }, { "name": "open-on-clear", "description": "When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Applies the outlined style to the input", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-placeholder", "description": "Forces placeholder to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "placeholder", "description": "Sets the input's placeholder text", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prefix", "description": "Displays prefix text", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-inner-icon", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-object", "description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Reverses the input orientation", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the input", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "shaped", "description": "Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-line", "description": "Label does not move on focus/dirty", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "small-chips", "description": "Changes display of selections to chips with the **small** property", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo", "description": "Changes the style of the input", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo-inverted", "description": "Reduces element opacity until focused", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "suffix", "description": "Displays suffix text", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "The comparison algorithm used for values. [More info](https://github.com/vuetifyjs/vuetify/blob/v2-stable/packages/vuetify/src/util/helpers.ts)", "doc-url": "https://www.vuetifyjs.com/api/v-select#props", "default": "(a: any, b: any): boolean", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "blur", "description": "Emitted when the input is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:append-outer", "description": "Emitted when appended outer icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:clear", "description": "Emitted when clearable icon clicked", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend-inner", "description": "Emitted when prepended inner icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "focus", "description": "Emitted when component is focused", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "keydown", "description": "Emitted when **any** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "boolean" } ] }, { "name": "update:list-index", "description": "Emitted when menu item is selected using keyboard arrows", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:search-input", "description": "The `search-input.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-select#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "append-item", "description": "Adds an item after menu content", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "append-outer", "description": "Adds an item outside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "counter", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots", "vue-properties": [ { "name": "props", "type": "{\"dark\":\"boolean\",\"light\":\"boolean\",\"max\":\"string | number\",\"value\":\"string\"}" } ] }, { "name": "item", "description": "Define a custom item appearance", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "on", "type": "object // Only needed when providing your own v-list-item" }, { "name": "attrs", "type": "object // Only needed when providing your own v-list-item" } ] }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "no-data", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "prepend-inner", "description": "Adds an item inside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "prepend-item", "description": "Adds an item before menu content", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots" }, { "name": "selection", "description": "Define a custom selection appearance", "doc-url": "https://www.vuetifyjs.com/api/v-select#slots", "vue-properties": [ { "name": "parent", "type": "VueComponent" }, { "name": "item", "type": "object" }, { "name": "index", "type": "number" }, { "name": "select", "type": "function" }, { "name": "selected", "type": "boolean" }, { "name": "disabled", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSkeletonLoader", "source": { "module": "./src/components/index.ts", "symbol": "VSkeletonLoader" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader", "attributes": [ { "name": "boilerplate", "description": "Remove the loading animation from the skeleton", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loading", "description": "Applies a loading animation with a on-hover loading cursor. A value of **false** will only work when there is content in the `default` slot.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loading-text", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "'$vuetify.loading'", "value": { "kind": "expression", "type": "string" } }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "tile", "description": "Removes the component's border-radius", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "type", "description": "A string delimited list of skeleton components to create such as `type=\"text@3\"` or `type=\"card, list-item\"`. Will recursively generate a corresponding skeleton from the provided string. Also supports short-hand for multiple elements such as **article@3** and **paragraph@2** which will generate 3 _article_ skeletons and 2 _paragraph_ skeletons. Please see below for a list of available pre-defined options.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "types", "description": "A custom types object that will be combined with the pre-defined options. For a list of available pre-defined options, see the **type** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "{}", "value": { "kind": "expression", "type": "object" } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-skeleton-loader#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSlider", "source": { "module": "./src/components/index.ts", "symbol": "VSlider" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slider", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "inverse-label", "description": "Reverse the label position. Works with **rtl**.", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "max", "description": "Sets the maximum allowed value", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "100", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "min", "description": "Sets the minimum allowed value", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "step", "description": "If greater than 0, sets step interval for ticks", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "thumb-color", "description": "Sets the thumb and thumb label color", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "thumb-label", "description": "Show thumb label. If `true` it shows label when using slider. If set to `'always'` it always shows label.", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "thumb-size", "description": "Controls the size of the thumb label.", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "32", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "tick-labels", "description": "When provided with Array, will attempt to map the labels to each step in index order", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "tick-size", "description": "Controls the size of **ticks**", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "ticks", "description": "Show track ticks. If `true` it shows ticks when using slider. If set to `'always'` it always shows ticks.", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "track-color", "description": "Sets the track's color", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "track-fill-color", "description": "Sets the track's fill color", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "value": { "kind": "expression", "type": "any" } }, { "name": "vertical", "description": "Changes slider direction to vertical", "doc-url": "https://www.vuetifyjs.com/api/v-slider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "end", "description": "Slider value emitted at the end of slider movement", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "start", "description": "Slider value emitted at start of slider movement", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "number" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-slider#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-slider#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-slider#slots" }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-slider#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slider#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-slider#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-slider#slots" }, { "name": "thumb-label", "description": "Replaces the content inside the thumb label", "doc-url": "https://www.vuetifyjs.com/api/v-slider#slots", "vue-properties": [ { "name": "value", "type": "number | string" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSlideGroup", "source": { "module": "./src/components/index.ts", "symbol": "VSlideGroup" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "'v-slide-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "center-active", "description": "Forces the selected component to be centered", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "mobile-breakpoint", "description": "Sets the designated mobile breakpoint for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "next-icon", "description": "The appended slot when arrows are shown", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "'$next'", "value": { "kind": "expression", "type": "string" } }, { "name": "prev-icon", "description": "The prepended slot when arrows are shown", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "'$prev'", "value": { "kind": "expression", "type": "string" } }, { "name": "show-arrows", "description": "Change when the overflow arrow indicators are shown. By **default**, arrows *always* display on Desktop when the container is overflowing. When the container overflows on mobile, arrows are not shown by default. A **show-arrows** value of `true` allows these arrows to show on Mobile if the container overflowing. A value of `desktop` *always* displays arrows on Desktop while a value of `mobile` always displays arrows on Mobile. A value of `always` always displays arrows on Desktop *and* Mobile. A value of `never` always hides the arrows. Find more information on how to customize breakpoint thresholds on the [breakpoints page](/customizing/breakpoints).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the component value is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#events", "arguments": [ { "name": "argument", "type": "any[] | any" } ] }, { "name": "click:next", "description": "Emitted when the next is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "click:prev", "description": "Emitted when the prev is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#events", "arguments": [ { "name": "argument", "type": "void" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#slots" }, { "name": "next", "description": "The next slot", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#slots" }, { "name": "prev", "description": "The prev slot", "doc-url": "https://www.vuetifyjs.com/api/v-slide-group#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSlideItem", "source": { "module": "./src/components/index.ts", "symbol": "VSlideItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slide-item", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-item#props", "value": { "kind": "expression", "type": "string" } }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The value used when the component is selected in a group. If not provided, the index will be used.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-item#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-slide-item#slots", "vue-properties": [ { "name": "active", "type": "boolean" }, { "name": "toggle", "type": "Function" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSnackbar", "source": { "module": "./src/components/index.ts", "symbol": "VSnackbar" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "app", "description": "Respects boundaries of—and will not overlap with—other `app` components like `v-app-bar`, `v-navigation-drawer`, and `v-footer`.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "centered", "description": "Positions the snackbar in the center of the screen, (x and y axis).", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "content-class", "description": "Apply a custom class to the snackbar content", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "left", "description": "Aligns the component towards the left.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multi-line", "description": "Gives the snackbar a larger minimum height.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "right", "description": "Aligns the component towards the right.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "text", "description": "Applies the defined **color** to text and a low opacity background of the same.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "timeout", "description": "Time (in milliseconds) to wait until snackbar is automatically hidden. Use `-1` to keep open indefinitely (`0` in version < 2.3 ). It is recommended for this number to be between `4000` and `10000`. Changes to this property will reset the timeout.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "5000", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "top", "description": "Aligns the content towards the top.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "v-snack-transition", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "vertical", "description": "Stacks snackbar content on top of the actions (button).", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "action", "description": "Used to bind styles to [v-btn](/components/buttons) to match MD2 specification.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#slots", "vue-properties": [ { "name": "attrs", "type": "object" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-snackbar#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSparkline", "source": { "module": "./src/components/index.ts", "symbol": "VSparkline" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline", "attributes": [ { "name": "auto-draw", "description": "Trace the length of the line when first rendered", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "auto-draw-duration", "description": "Amount of time (in ms) to run the trace animation", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "2000", "value": { "kind": "expression", "type": "number" } }, { "name": "auto-draw-easing", "description": "The easing function to use for the trace animation", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "'ease'", "value": { "kind": "expression", "type": "string" } }, { "name": "auto-line-width", "description": "Automatically expand bars to use space efficiently", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "fill", "description": "Using the **fill** property allows you to better customize the look and feel of your sparkline.", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "gradient", "description": "An array of colors to use as a linear-gradient", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "gradient-direction", "description": "The direction the gradient should run", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "'top'", "value": { "kind": "expression", "type": "string" } }, { "name": "height", "description": "Height of the SVG trendline or bars", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "75", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "label-size", "description": "The label font size", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "7", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "labels", "description": "An array of string labels that correspond to the same index as its data counterpart", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "line-width", "description": "The thickness of the line, in px", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "4", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "padding", "description": "Low `smooth` or high `line-width` values may result in cropping, increase padding to compensate", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "8", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "show-labels", "description": "Show labels below each data point", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "smooth", "description": "Number of px to use as a corner radius. `true` defaults to 8, `false` is 0", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "type", "description": "Choose between a trendline or bars", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "'trend'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "An array of numbers.", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "width", "description": "Width of the SVG trendline or bars", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#props", "default": "300", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-sparkline#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSpeedDial", "source": { "module": "./src/components/index.ts", "symbol": "VSpeedDial" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "direction", "description": "Direction in which speed-dial content will show. Possible values are `top`, `bottom`, `left`, `right`.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "'top'", "value": { "kind": "expression", "type": "string" } }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "left", "description": "Aligns the component towards the left.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "open-on-hover", "description": "Opens speed-dial on hover", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "right", "description": "Aligns the component towards the right.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "top", "description": "Aligns the content towards the top.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "'scale-transition'", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [], "slots": [ { "name": "activator", "description": "When used, will activate the component when clicked (or hover for specific components). This manually stops the event propagation. Without this slot, if you open the component through its model, you will need to manually stop the event propagation", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#slots" }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-speed-dial#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VStepper", "source": { "module": "./src/components/index.ts", "symbol": "VStepper" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-stepper", "attributes": [ { "name": "alt-labels", "description": "Places the labels beneath the step", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "flat", "description": "Removes the stepper's elevation.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "non-linear", "description": "Allow user to jump to any step", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "vertical", "description": "Display steps vertically", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "change", "description": "Emitted when step is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#events", "arguments": [ { "name": "argument", "type": "number" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VStepperContent", "source": { "module": "./src/components/index.ts", "symbol": "VStepperContent" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-content", "attributes": [ { "name": "step", "description": "Sets step to associate the content to", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-content#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-content#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VStepperStep", "source": { "module": "./src/components/index.ts", "symbol": "VStepperStep" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "complete", "description": "Marks step as complete", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "complete-icon", "description": "Icon to display when step is marked as completed", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "'$complete'", "value": { "kind": "expression", "type": "string" } }, { "name": "edit-icon", "description": "Icon to display when step is editable", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "'$edit'", "value": { "kind": "expression", "type": "string" } }, { "name": "editable", "description": "Marks step as editable", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-icon", "description": "Icon to display when step has an error", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "'$error'", "value": { "kind": "expression", "type": "string" } }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "step", "description": "Content to display inside step circle", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "click", "description": "Emitted when component is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-step#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VStepperHeader", "source": { "module": "./src/components/index.ts", "symbol": "VStepperHeader" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-header", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-header#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-header#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VStepperItems", "source": { "module": "./src/components/index.ts", "symbol": "VStepperItems" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-items", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-items#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-stepper-items#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSubheader", "source": { "module": "./src/components/index.ts", "symbol": "VSubheader" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-subheader", "attributes": [ { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-subheader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "inset", "description": "Adds indentation (72px)", "doc-url": "https://www.vuetifyjs.com/api/v-subheader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-subheader#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-subheader#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSwitch", "source": { "module": "./src/components/index.ts", "symbol": "VSwitch" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-switch", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "false-value", "description": "Sets value for falsy state", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "flat", "description": "Display component without elevation. Default elevation for thumb is 4dp, `flat` resets it", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "input-value", "description": "The **v-model** bound value", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "inset", "description": "Enlarge the `v-switch` track to encompass the thumb", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loading", "description": "Displays circular progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - primary, secondary, success, info, warning, error) or a Boolean which uses the component color (set by color prop - if it's supported by the component) or the primary color", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "multiple", "description": "Changes expected model to an array", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "true", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "true-value", "description": "Sets value for truthy state", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-switch#props", "default": "null", "value": { "kind": "expression", "type": "function" } } ], "events": [ { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-switch#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked. **Note:** the **change** event should be used instead of **click** when monitoring state change", "doc-url": "https://www.vuetifyjs.com/api/v-switch#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-switch#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-switch#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-switch#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-switch#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-switch#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-switch#slots" }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-switch#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-switch#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSystemBar", "source": { "module": "./src/components/index.ts", "symbol": "VSystemBar" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "app", "description": "Designates the component as part of the application layout. Used for dynamically adjusting content sizing. Components using this prop should reside **outside** of `v-main` component to function properly. You can find more information about layouts on the [application page](/components/application). **Note:** this prop automatically applies **position: fixed** to the layout element. You can overwrite this functionality by using the `absolute` prop", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed", "description": "Applies **position: fixed** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "lights-out", "description": "Reduces the system bar opacity.", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "window", "description": "Increases the system bar height to 32px (24px default).", "doc-url": "https://www.vuetifyjs.com/api/v-system-bar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTabs", "source": { "module": "./src/components/index.ts", "symbol": "VTabs" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tabs", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "align-with-title", "description": "Make `v-tabs` lined up with the toolbar title", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background color of the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "center-active", "description": "Forces the selected tab to be centered", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "centered", "description": "Centers the tabs", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fixed-tabs", "description": "`v-tabs-item` min-width 160px, max-width 360px", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "grow", "description": "Force `v-tab`'s to take up all available space", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the tabs bar", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-slider", "description": "Hide's the generated `v-tabs-slider`", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "icons-and-text", "description": "Will stack icon and text vertically", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mobile-breakpoint", "description": "Sets the designated mobile breakpoint for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "number" ] } }, { "name": "next-icon", "description": "Right pagination icon", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "'$next'", "value": { "kind": "expression", "type": "string" } }, { "name": "optional", "description": "Does not require an active item. Useful when using `v-tab` as a `router-link`", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prev-icon", "description": "Left pagination icon", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "'$prev'", "value": { "kind": "expression", "type": "string" } }, { "name": "right", "description": "Aligns tabs to the right", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-arrows", "description": "Show pagination arrows if the tab items overflow their container. For mobile devices, arrows will only display when using this prop.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "slider-color", "description": "Changes the background color of an auto-generated `v-tabs-slider`", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "slider-size", "description": "Changes the size of the slider, **height** for horizontal, **width** for vertical.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "vertical", "description": "Stacks tabs on top of each other vertically.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "change", "description": "Emitted when tab is changed by user interaction. Returns a string if **href** attribute is set and number if it is not.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#events", "arguments": [ { "name": "argument", "type": "number | string" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTab", "source": { "module": "./src/components/index.ts", "symbol": "VTab" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tab", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "value": { "kind": "expression", "type": "string" } }, { "name": "append", "description": "Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "exact-active-class", "description": "Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "exact-path", "description": "Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "href", "description": "Designates the component as anchor and applies the **href** attribute.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "link", "description": "Designates that the component is a link. This is automatic when using the **href** or **to** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "nuxt", "description": "Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/).", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-tab#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "ripple", "description": "Applies the [v-ripple](/directives/ripple) directive.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "true", "value": { "kind": "expression", "type": [ "boolean", "object" ] } }, { "name": "tab-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "target", "description": "Designates the target attribute. This should only be applied when using the **href** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "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://www.vuetifyjs.com/api/v-tab#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } } ], "events": [ { "name": "change", "description": "Emitted when tab becomes active", "doc-url": "https://www.vuetifyjs.com/api/v-tab#events", "arguments": [ { "name": "argument", "type": "void" } ] }, { "name": "click", "description": "Emitted when the component is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-tab#events", "arguments": [ { "name": "argument", "type": "ClickEvent" } ] }, { "name": "keydown", "description": "Emitted when **enter** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-tab#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-tab#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTabItem", "source": { "module": "./src/components/index.ts", "symbol": "VTabItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#props", "value": { "kind": "expression", "type": "string" } }, { "name": "disabled", "description": "Removes the ability to click or target the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "reverse-transition", "description": "Sets the reverse transition", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "transition", "description": "The transition used when the component progressing through items. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "value", "description": "Sets the value of the tab. If not provided, the index will be used.", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-tab-item#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTabsItems", "source": { "module": "./src/components/index.ts", "symbol": "VTabsItems" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "'v-window-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "continuous", "description": "If `true`, window will \"wrap around\" from the last item to the first, and from the first item to the last", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mandatory", "description": "Forces a value to always be selected (if available).", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Sets a maximum number of selections that can be made.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "multiple", "description": "Allow multiple selections. The **value** prop must be an _array_.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "next-icon", "description": "Icon used for the \"next\" button if `show-arrows` is `true`", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "$next", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "prev-icon", "description": "Icon used for the \"prev\" button if `show-arrows` is `true`", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "$prev", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "reverse", "description": "Reverse the normal transition direction.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-arrows", "description": "Display the \"next\" and \"prev\" buttons", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-arrows-on-hover", "description": "Display the \"next\" and \"prev\" buttons on hover. `show-arrows` MUST ALSO be set.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "touch", "description": "Provide a custom **left** and **right** function when swiped left or right.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "touchless", "description": "Disable touch support.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "vertical", "description": "Uses a vertical transition when changing windows.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "change", "description": "Emitted when user swipes between tabs.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-items#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTabsSlider", "source": { "module": "./src/components/index.ts", "symbol": "VTabsSlider" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-slider", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-tabs-slider#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTextarea", "source": { "module": "./src/components/index.ts", "symbol": "VTextarea" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-textarea", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "append-outer-icon", "description": "Appends an icon to the outside the component's input, uses same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "auto-grow", "description": "Automatically grow the textarea depending on amount of text", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "autofocus", "description": "Enables autofocus", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "clear-icon", "description": "Applied when using **clearable** and the input is dirty", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "'$clear'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Add input clear functionality, default icon is Material Design Icons **mdi-clear**", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "counter", "description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "counter-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "filled", "description": "Applies the alternate filled input style", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Designates input type as full-width", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "no-resize", "description": "Remove resize handle", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "outlined", "description": "Applies the outlined style to the input", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-placeholder", "description": "Forces placeholder to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "placeholder", "description": "Sets the input's placeholder text", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prefix", "description": "Displays prefix text", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-inner-icon", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Reverses the input orientation", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the input", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "row-height", "description": "Height value for each row. Requires the use of the **auto-grow** prop.", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "24", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "rows", "description": "Default row count", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "5", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "shaped", "description": "Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-line", "description": "Label does not move on focus/dirty", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo", "description": "Changes the style of the input", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo-inverted", "description": "Reduces element opacity until focused", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "suffix", "description": "Displays suffix text", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#props", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "blur", "description": "Emitted when the input is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:append-outer", "description": "Emitted when appended outer icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:clear", "description": "Emitted when clearable icon clicked", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend-inner", "description": "Emitted when prepended inner icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "focus", "description": "Emitted when component is focused", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "keydown", "description": "Emitted when **any** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots" }, { "name": "append-outer", "description": "Adds an item outside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots" }, { "name": "counter", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots", "vue-properties": [ { "name": "props", "type": "{\"dark\":\"boolean\",\"light\":\"boolean\",\"max\":\"string | number\",\"value\":\"string\"}" } ] }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots" }, { "name": "prepend-inner", "description": "Adds an item inside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-textarea#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTextField", "source": { "module": "./src/components/index.ts", "symbol": "VTextField" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-text-field", "attributes": [ { "name": "append-icon", "description": "Appends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "append-outer-icon", "description": "Appends an icon to the outside the component's input, uses same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "autofocus", "description": "Enables autofocus", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "background-color", "description": "Changes the background-color of the input", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "clear-icon", "description": "Applied when using **clearable** and the input is dirty", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "'$clear'", "value": { "kind": "expression", "type": "string" } }, { "name": "clearable", "description": "Add input clear functionality, default icon is Material Design Icons **mdi-clear**", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "counter", "description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "number", "string" ] } }, { "name": "counter-value", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the input height", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disable the input", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error", "description": "Puts the input in a manual error state", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "error-count", "description": "The total number of errors that should display at once", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "1", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "error-messages", "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", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "filled", "description": "Applies the alternate filled input style", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "flat", "description": "Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "full-width", "description": "Designates input type as full-width", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "height", "description": "Sets the height of the input", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "hide-details", "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", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "hide-spin-buttons", "description": "Hides spin buttons on the input when type is set to `number`.", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hint", "description": "Hint text", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "id", "description": "Sets the DOM id on the component", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "label", "description": "Sets input label", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "value": { "kind": "expression", "type": "string" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "loader-height", "description": "Specifies the height of the loader", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "2", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "messages", "description": "Displays a list of messages or message if using a string", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "outlined", "description": "Applies the outlined style to the input", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-hint", "description": "Forces hint to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "persistent-placeholder", "description": "Forces placeholder to always be visible", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "placeholder", "description": "Sets the input’s placeholder text", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prefix", "description": "Displays prefix text", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-icon", "description": "Prepends an icon to the component, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "prepend-inner-icon", "description": "Prepends an icon inside the component's input, uses the same syntax as `v-icon`", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "readonly", "description": "Puts input in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Reverses the input orientation", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Adds a border radius to the input", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rules", "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`", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "shaped", "description": "Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "single-line", "description": "Label does not move on focus/dirty", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo", "description": "Changes the style of the input", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "solo-inverted", "description": "Reduces element opacity until focused", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success", "description": "Puts the input in a manual success state", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "success-messages", "description": "Puts the input in a success state and passes through custom success messages.", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "[]", "value": { "kind": "expression", "type": [ "string", "array" ] } }, { "name": "suffix", "description": "Displays suffix text", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "type", "description": "Sets input type", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "'text'", "value": { "kind": "expression", "type": "string" } }, { "name": "validate-on-blur", "description": "Delays validation until blur event", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The input's value", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#props", "value": { "kind": "expression", "type": "any" } } ], "events": [ { "name": "blur", "description": "Emitted when the input is blurred", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "change", "description": "Emitted when the input is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "click", "description": "Emitted when input is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "click:append", "description": "Emitted when appended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:append-outer", "description": "Emitted when appended outer icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:clear", "description": "Emitted when clearable icon clicked", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend", "description": "Emitted when prepended icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "click:prepend-inner", "description": "Emitted when prepended inner icon is clicked", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "focus", "description": "Emitted when component is focused", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "Event" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "any" } ] }, { "name": "keydown", "description": "Emitted when **any** key is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "KeyboardEvent" } ] }, { "name": "mousedown", "description": "Emitted when click is pressed", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "mouseup", "description": "Emitted when click is released", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "MouseEvent" } ] }, { "name": "update:error", "description": "The `error.sync` event", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#events", "arguments": [ { "name": "argument", "type": "boolean" } ] } ], "slots": [ { "name": "append", "description": "Adds an item inside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots" }, { "name": "append-outer", "description": "Adds an item outside the input and after input content", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots" }, { "name": "counter", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots", "vue-properties": [ { "name": "props", "type": "{\"dark\":\"boolean\",\"light\":\"boolean\",\"max\":\"string | number\",\"value\":\"string\"}" } ] }, { "name": "label", "description": "Replaces the default label", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots" }, { "name": "message", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots", "vue-properties": [ { "name": "key", "type": "number, // the messages index" }, { "name": "message", "type": "string, // the message" } ] }, { "name": "prepend", "description": "Adds an item outside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots" }, { "name": "prepend-inner", "description": "Adds an item inside the input and before input content", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots" }, { "name": "progress", "description": "Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False)", "doc-url": "https://www.vuetifyjs.com/api/v-text-field#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VThemeProvider", "source": { "module": "./src/components/index.ts", "symbol": "VThemeProvider" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-theme-provider", "attributes": [ { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-theme-provider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-theme-provider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "root", "description": "Use the current value of `$vuetify.theme.dark` as opposed to the provided one.", "doc-url": "https://www.vuetifyjs.com/api/v-theme-provider#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTimeline", "source": { "module": "./src/components/index.ts", "symbol": "VTimeline" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-timeline", "attributes": [ { "name": "align-top", "description": "Align caret and dot of timeline items to the top", "doc-url": "https://www.vuetifyjs.com/api/v-timeline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-timeline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Hide opposite slot content, and position all items to one side of timeline", "doc-url": "https://www.vuetifyjs.com/api/v-timeline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-timeline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse", "description": "Reverse direction of timeline items", "doc-url": "https://www.vuetifyjs.com/api/v-timeline#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-timeline#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTimelineItem", "source": { "module": "./src/components/index.ts", "symbol": "VTimelineItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item", "attributes": [ { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "fill-dot", "description": "Remove padding from dot container", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-dot", "description": "Hide display of timeline dot", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "icon", "description": "Specify icon for dot container", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "icon-color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "large", "description": "Large size dot", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "left", "description": "Explicitly set the item to a left orientation", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "right", "description": "Explicitly set the item to a right orientation", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "small", "description": "Small size dot", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#slots" }, { "name": "icon", "description": "Used to customize the icon inside the timeline item's dot", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#slots" }, { "name": "opposite", "description": "Used to customize the opposite side of timeline items", "doc-url": "https://www.vuetifyjs.com/api/v-timeline-item#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTimePicker", "source": { "module": "./src/components/index.ts", "symbol": "VTimePicker" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker", "attributes": [ { "name": "active-picker", "description": "Determines which picker is being displayed. Allowed values: `'HOUR'`, `'MINUTE'`, `'SECOND'`", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "allowed-hours", "description": "Restricts which hours can be selected", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "function", "array" ] } }, { "name": "allowed-minutes", "description": "Restricts which minutes can be selected", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "function", "array" ] } }, { "name": "allowed-seconds", "description": "Restricts which seconds can be selected", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "function", "array" ] } }, { "name": "ampm-in-title", "description": "Place AM/PM switch in title, not near the clock.", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "disables picker", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "flat", "description": "Removes elevation", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "format", "description": "Defines the format of a time displayed in picker. Available options are `ampm` and `24hr`.", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "'ampm'", "value": { "kind": "expression", "type": "string" } }, { "name": "full-width", "description": "Forces 100% width", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "header-color", "description": "Defines the header color. If not specified it will use the color defined by color prop or the default picker color", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "landscape", "description": "Orients picker horizontal", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max", "description": "Maximum allowed time", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "min", "description": "Minimum allowed time", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "no-title", "description": "Hide the picker title", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "readonly", "description": "Puts picker in readonly state", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "scrollable", "description": "Allows changing hour/minute with mouse scroll", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "use-seconds", "description": "Toggles the use of seconds in picker", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "Time picker model (ISO 8601 format, 24hr hh:mm)", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "width", "description": "Width of the picker", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#props", "default": "290", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [ { "name": "change", "description": "Emitted when the time selection is done (when user changes the minute for HH:MM picker and the second for HH:MM:SS picker", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "click:hour", "description": "Emitted when user selects the hour", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "click:minute", "description": "Emitted when user selects the minute", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "click:second", "description": "Emitted when user selects the second", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "input", "description": "The updated bound model", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "update:active-picker", "description": "The `.sync` event for `active-picker` prop", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] }, { "name": "update:period", "description": "Emitted when user clicks the AM/PM button", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#events", "arguments": [ { "name": "argument", "type": "string" } ] } ], "slots": [ { "name": "default", "description": "Displayed below the clock, can be used for example for adding action button (`OK` and `Cancel`)", "doc-url": "https://www.vuetifyjs.com/api/v-time-picker#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VToolbar", "source": { "module": "./src/components/index.ts", "symbol": "VToolbar" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar", "attributes": [ { "name": "absolute", "description": "Applies position: absolute to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "collapse", "description": "Puts the toolbar into a collapsed state reducing its maximum width.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Reduces the height of the toolbar content to 48px (96px when using the **prominent** prop).", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "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://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "extension-height", "description": "Specify an explicit height for the `extension` slot. ", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "48", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "flat", "description": "Removes the toolbar's box-shadow.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "floating", "description": "Applies **display: inline-flex** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "outlined", "description": "Removes elevation (box-shadow) and adds a *thin* border.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "prominent", "description": "Increases the height of the toolbar content to 128px.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "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://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "shaped", "description": "Applies a large border radius on the top left and bottom right of the card.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "short", "description": "Reduce the height of the toolbar content to 56px (112px when using the **prominent** prop).", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "src", "description": "Specifies a [v-img](/components/images) as the component's background.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "string", "object" ] } }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "'header'", "value": { "kind": "expression", "type": "string" } }, { "name": "tile", "description": "Removes the component's **border-radius**.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#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. If this slot has no content, the **extended** prop may be used instead.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#slots" }, { "name": "img", "description": "Expects the [v-img](/components/images) component. Scoped **props** should be applied with `v-bind=\"props\"`.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar#slots", "vue-properties": [ { "name": "props", "type": "{ height: string, src: string | srcObject }" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VToolbarItems", "source": { "module": "./src/components/index.ts", "symbol": "VToolbarItems" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar-items", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar-items#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar-items#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VToolbarTitle", "source": { "module": "./src/components/index.ts", "symbol": "VToolbarTitle" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar-title", "attributes": [ { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar-title#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-toolbar-title#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTooltip", "source": { "module": "./src/components/index.ts", "symbol": "VTooltip" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip", "attributes": [ { "name": "absolute", "description": "Applies **position: absolute** to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "activator", "description": "Designate a custom activator when the `activator` slot is not used. String can be any valid querySelector and Object can be any valid Node.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "allow-overflow", "description": "Removes overflow re-positioning for the content", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "attach", "description": "Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "any" } }, { "name": "bottom", "description": "Aligns the component towards the bottom.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "close-delay", "description": "Delay (in ms) after which menu closes (when open-on-hover prop is set to true)", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "color", "description": "Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors).", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "content-class", "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.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "disabled", "description": "Disables the tooltip", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "internal-activator", "description": "Designates whether to use an internal activator", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "left", "description": "Aligns the component towards the left.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "max-width", "description": "Sets the maximum width for the content", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "auto", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the content", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-bottom", "description": "Nudge the content to the bottom", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-left", "description": "Nudge the content to the left", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-right", "description": "Nudge the content to the right", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-top", "description": "Nudge the content to the top", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "nudge-width", "description": "Nudge the content width", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "offset-overflow", "description": "Causes the component to flip to the opposite side when repositioned due to overflow", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-delay", "description": "Delay (in ms) after which tooltip opens (when `open-on-hover` prop is set to **true**)", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "open-on-click", "description": "Designates whether the tooltip should open on activator click", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-focus", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-hover", "description": "Designates whether the tooltip should open on activator hover", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "true", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "position-x", "description": "Used to position the content when not using an activator slot", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": "number" } }, { "name": "position-y", "description": "Used to position the content when not using an activator slot", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": "number" } }, { "name": "right", "description": "Aligns the component towards the right.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specifies a custom tag for the activator wrapper", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "'span'", "value": { "kind": "expression", "type": "string" } }, { "name": "top", "description": "Aligns the content towards the top.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "value", "description": "Controls whether the component is visible or hidden.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "z-index", "description": "The z-index used for the component", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "activator", "description": "When used, will activate the component when clicked (or hover for specific components). This manually stops the event propagation. Without this slot, if you open the component through its model, you will need to manually stop the event propagation", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#slots", "vue-properties": [ { "name": "on", "type": "{ [eventName]: eventHandler }" }, { "name": "value", "type": "boolean" } ] }, { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-tooltip#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTreeview", "source": { "module": "./src/components/index.ts", "symbol": "VTreeview" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-treeview", "attributes": [ { "name": "activatable", "description": "Allows user to mark a node as active by clicking on it", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "active", "description": "Syncable prop that allows one to control which nodes are active. The array consists of the `item-key` of each active item.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "active-class", "description": "The class applied to the node when active", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'v-treeview-node--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "color", "description": "Sets the color of the active node", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'primary'", "value": { "kind": "expression", "type": "string" } }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dense", "description": "Decreases the height of the items", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disable-per-node", "description": "Prevents disabling children nodes", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "disabled", "description": "Disables selection for all nodes", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "expand-icon", "description": "Icon used to indicate that a node can be expanded", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'$subgroup'", "value": { "kind": "expression", "type": "string" } }, { "name": "filter", "description": "Custom item filtering function. By default it will use case-insensitive search in item's label.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "hoverable", "description": "Applies a hover class when mousing over nodes", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "indeterminate-icon", "description": "Icon used when node is in an indeterminate state. Only visible when `selectable` is `true`.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'$checkboxIndeterminate'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-children", "description": "Property on supplied `items` that contains its children", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'children'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-disabled", "description": "Property on supplied `items` that contains the disabled state of the item", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'disabled'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-key", "description": "Property on supplied `items` used to keep track of node state. The value of this property has to be unique among all items.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'id'", "value": { "kind": "expression", "type": "string" } }, { "name": "item-text", "description": "Property on supplied `items` that contains its label text", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'name'", "value": { "kind": "expression", "type": "string" } }, { "name": "items", "description": "An array of items used to build the treeview", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "load-children", "description": "A function used when dynamically loading children. If this prop is set, then the supplied function will be run if expanding an item that has a `item-children` property that is an empty array. Supports returning a Promise.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "loading-icon", "description": "Icon used when node is in a loading state", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'$loading'", "value": { "kind": "expression", "type": "string" } }, { "name": "multiple-active", "description": "When `true`, allows user to have multiple active nodes at the same time", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "off-icon", "description": "Icon used when node is not selected. Only visible when `selectable` is `true`.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'$checkboxOff'", "value": { "kind": "expression", "type": "string" } }, { "name": "on-icon", "description": "Icon used when leaf node is selected or when a branch node is fully selected. Only visible when `selectable` is `true`.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'$checkboxOn'", "value": { "kind": "expression", "type": "string" } }, { "name": "open", "description": "Syncable prop that allows one to control which nodes are open. The array consists of the `item-key` of each open item.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "open-all", "description": "When `true` will cause all branch nodes to be opened when component is mounted", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "open-on-click", "description": "When `true` will cause nodes to be opened by clicking anywhere on it, instead of only opening by clicking on expand icon. When using this prop with `activatable` you will be unable to mark nodes with children as active.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "return-object", "description": "When `true` will make `v-model`, `active.sync` and `open.sync` return the complete object instead of just the key", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "rounded", "description": "Provides an alternative active style for `v-treeview` node. Only visible when `activatable` is `true` and should not be used in conjunction with the `shaped` prop.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "search", "description": "The search model for filtering results", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "selectable", "description": "Will render a checkbox next to each node allowing them to be selected", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "selected-color", "description": "The color of the selection checkbox", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'accent'", "value": { "kind": "expression", "type": "string" } }, { "name": "selection-type", "description": "Controls how the treeview selects nodes. There are two modes available: 'leaf' and 'independent'", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "'leaf'", "value": { "kind": "expression", "type": "string" } }, { "name": "shaped", "description": "Provides an alternative active style for `v-treeview` node. Only visible when `activatable` is `true` and should not be used in conjunction with the `rounded` prop.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "transition", "description": "Applies a transition when nodes are opened and closed", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "Allows one to control which nodes are selected. The array consists of the `item-key` of each selected item. Is used with `@input` event to allow for `v-model` binding.", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#props", "default": "[]", "value": { "kind": "expression", "type": "array" } } ], "events": [ { "name": "input", "description": "Emits the array of selected items when this value changes", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#events", "arguments": [ { "name": "argument", "type": "array" } ] }, { "name": "update:active", "description": "Emits the array of active items when this value changes", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#events", "arguments": [ { "name": "argument", "type": "array" } ] }, { "name": "update:open", "description": "Emits the array of open items when this value changes", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#events", "arguments": [ { "name": "argument", "type": "array" } ] } ], "slots": [ { "name": "append", "description": "Appends content after label", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#slots", "vue-properties": [ { "name": "item", "type": "any" }, { "name": "leaf", "type": "boolean" }, { "name": "selected", "type": "boolean" }, { "name": "indeterminate", "type": "boolean" }, { "name": "active", "type": "boolean" }, { "name": "open", "type": "boolean" } ] }, { "name": "label", "description": "Label content", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#slots", "vue-properties": [ { "name": "item", "type": "any" }, { "name": "leaf", "type": "boolean" }, { "name": "selected", "type": "boolean" }, { "name": "indeterminate", "type": "boolean" }, { "name": "active", "type": "boolean" }, { "name": "open", "type": "boolean" } ] }, { "name": "prepend", "description": "Prepends content before label", "doc-url": "https://www.vuetifyjs.com/api/v-treeview#slots", "vue-properties": [ { "name": "item", "type": "any" }, { "name": "leaf", "type": "boolean" }, { "name": "selected", "type": "boolean" }, { "name": "indeterminate", "type": "boolean" }, { "name": "active", "type": "boolean" }, { "name": "open", "type": "boolean" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VVirtualScroll", "source": { "module": "./src/components/index.ts", "symbol": "VVirtualScroll" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll", "attributes": [ { "name": "bench", "description": "The number of items **outside** the user view that are rendered (even if they are **not** viewable); to help prevent empty white space when scrolling *fast*.", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "0", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "height", "description": "Height of the component as a css value", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "item-height", "description": "Height in pixels of the items to display", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "items", "description": "The array of items to display", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "[]", "value": { "kind": "expression", "type": "array" } }, { "name": "max-height", "description": "Sets the maximum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "max-width", "description": "Sets the maximum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-height", "description": "Sets the minimum height for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "min-width", "description": "Sets the minimum width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } }, { "name": "width", "description": "Sets the width for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#props", "default": "undefined", "value": { "kind": "expression", "type": [ "number", "string" ] } } ], "events": [], "slots": [ { "name": "default", "description": "Default slot to customize items appearance", "doc-url": "https://www.vuetifyjs.com/api/v-virtual-scroll#slots", "vue-properties": [ { "name": "index", "type": "number" }, { "name": "item", "type": "any" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VWindow", "source": { "module": "./src/components/index.ts", "symbol": "VWindow" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-window", "attributes": [ { "name": "active-class", "description": "The **active-class** applied to children when they are activated.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "'v-window-item--active'", "value": { "kind": "expression", "type": "string" } }, { "name": "continuous", "description": "If `true`, window will \"wrap around\" from the last item to the first, and from the first item to the last", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "dark", "description": "Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html).", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "light", "description": "Applies the light theme variant to the component.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "next-icon", "description": "Icon used for the \"next\" button if `show-arrows` is `true`", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "$next", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "prev-icon", "description": "Icon used for the \"prev\" button if `show-arrows` is `true`", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "$prev", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "reverse", "description": "Reverse the normal transition direction.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-arrows", "description": "Display the \"next\" and \"prev\" buttons", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "show-arrows-on-hover", "description": "Display the \"next\" and \"prev\" buttons on hover. `show-arrows` MUST ALSO be set.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "tag", "description": "Specify a custom tag used on the root element.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "'div'", "value": { "kind": "expression", "type": "string" } }, { "name": "touch", "description": "Provide a custom **left** and **right** function when swiped left or right.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "undefined", "value": { "kind": "expression", "type": "object" } }, { "name": "touchless", "description": "Disable touch support.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "value", "description": "The designated model value for the component.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } }, { "name": "value-comparator", "description": "Apply a custom value comparator function", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "null", "value": { "kind": "expression", "type": "function" } }, { "name": "vertical", "description": "Uses a vertical transition when changing windows.", "doc-url": "https://www.vuetifyjs.com/api/v-window#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" } ], "events": [ { "name": "change", "description": "Emitted when the component value is changed by user interaction", "doc-url": "https://www.vuetifyjs.com/api/v-window#events", "arguments": [ { "name": "argument", "type": "number" } ] } ], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-window#slots" }, { "name": "next", "description": "Slot displaying the arrow switching to the next item", "doc-url": "https://www.vuetifyjs.com/api/v-window#slots", "vue-properties": [ { "name": "attrs", "type": "{ aria-label: string }" }, { "name": "on", "type": "{ click: eventHandler }" } ] }, { "name": "prev", "description": "Slot displaying the arrow switching to the previous item", "doc-url": "https://www.vuetifyjs.com/api/v-window#slots", "vue-properties": [ { "name": "attrs", "type": "{ aria-label: string }" }, { "name": "on", "type": "{ click: eventHandler }" } ] } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VWindowItem", "source": { "module": "./src/components/index.ts", "symbol": "VWindowItem" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-window-item", "attributes": [ { "name": "active-class", "description": "Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation.", "doc-url": "https://www.vuetifyjs.com/api/v-window-item#props", "value": { "kind": "expression", "type": "string" } }, { "name": "disabled", "description": "Prevents the item from becoming active when using the \"next\" and \"prev\" buttons or the `toggle` method", "doc-url": "https://www.vuetifyjs.com/api/v-window-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "eager", "description": "Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.", "doc-url": "https://www.vuetifyjs.com/api/v-window-item#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "reverse-transition", "description": "Sets the reverse transition", "doc-url": "https://www.vuetifyjs.com/api/v-window-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "transition", "description": "The transition used when the component progressing through items. Can be one of the [built in transitions](/styles/transitions) or one your own.", "doc-url": "https://www.vuetifyjs.com/api/v-window-item#props", "default": "undefined", "value": { "kind": "expression", "type": [ "boolean", "string" ] } }, { "name": "value", "description": "The value used when the component is selected in a group. If not provided, the index will be used.", "doc-url": "https://www.vuetifyjs.com/api/v-window-item#props", "default": "undefined", "value": { "kind": "expression", "type": "any" } } ], "events": [], "slots": [ { "name": "default", "description": "The default Vue slot.", "doc-url": "https://www.vuetifyjs.com/api/v-window-item#slots" } ], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCarouselTransition", "source": { "module": "./src/components/index.ts", "symbol": "VCarouselTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VCarouselReverseTransition", "source": { "module": "./src/components/index.ts", "symbol": "VCarouselReverseTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-reverse-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-reverse-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-carousel-reverse-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTabTransition", "source": { "module": "./src/components/index.ts", "symbol": "VTabTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tab-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-tab-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-tab-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-tab-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-tab-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-tab-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VTabReverseTransition", "source": { "module": "./src/components/index.ts", "symbol": "VTabReverseTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-tab-reverse-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-tab-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-tab-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-tab-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-tab-reverse-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-tab-reverse-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VMenuTransition", "source": { "module": "./src/components/index.ts", "symbol": "VMenuTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-menu-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-menu-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-menu-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-menu-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-menu-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-menu-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VFabTransition", "source": { "module": "./src/components/index.ts", "symbol": "VFabTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-fab-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-fab-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-fab-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-fab-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-fab-transition#props", "default": "'out-in'", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-fab-transition#props", "default": "'center center'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDialogTransition", "source": { "module": "./src/components/index.ts", "symbol": "VDialogTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDialogBottomTransition", "source": { "module": "./src/components/index.ts", "symbol": "VDialogBottomTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-bottom-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-bottom-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-bottom-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-bottom-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-bottom-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-bottom-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VDialogTopTransition", "source": { "module": "./src/components/index.ts", "symbol": "VDialogTopTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-top-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-top-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-top-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-top-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-top-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-dialog-top-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VFadeTransition", "source": { "module": "./src/components/index.ts", "symbol": "VFadeTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-fade-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-fade-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-fade-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-fade-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-fade-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-fade-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VScaleTransition", "source": { "module": "./src/components/index.ts", "symbol": "VScaleTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-scale-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-scale-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-scale-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-scale-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-scale-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-scale-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VScrollXTransition", "source": { "module": "./src/components/index.ts", "symbol": "VScrollXTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VScrollXReverseTransition", "source": { "module": "./src/components/index.ts", "symbol": "VScrollXReverseTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-reverse-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-reverse-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-x-reverse-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VScrollYTransition", "source": { "module": "./src/components/index.ts", "symbol": "VScrollYTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VScrollYReverseTransition", "source": { "module": "./src/components/index.ts", "symbol": "VScrollYReverseTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-reverse-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-reverse-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-scroll-y-reverse-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSlideXTransition", "source": { "module": "./src/components/index.ts", "symbol": "VSlideXTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSlideXReverseTransition", "source": { "module": "./src/components/index.ts", "symbol": "VSlideXReverseTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-reverse-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-reverse-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-x-reverse-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSlideYTransition", "source": { "module": "./src/components/index.ts", "symbol": "VSlideYTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VSlideYReverseTransition", "source": { "module": "./src/components/index.ts", "symbol": "VSlideYReverseTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-reverse-transition", "attributes": [ { "name": "group", "description": "Creates a `transition-group` component. [vue docs](https://vuejs.org/v2/api/#transition-group)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "hide-on-leave", "description": "Hides the leaving element (no exit animation)", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "leave-absolute", "description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-reverse-transition#props", "default": "false", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean" }, { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-reverse-transition#props", "default": "undefined", "value": { "kind": "expression", "type": "string" } }, { "name": "origin", "description": "Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin).", "doc-url": "https://www.vuetifyjs.com/api/v-slide-y-reverse-transition#props", "default": "'top center 0'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VExpandTransition", "source": { "module": "./src/components/index.ts", "symbol": "VExpandTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-expand-transition", "attributes": [ { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-expand-transition#props", "default": "'in-out'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } }, { "name": "VExpandXTransition", "source": { "module": "./src/components/index.ts", "symbol": "VExpandXTransition" }, "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-expand-x-transition", "attributes": [ { "name": "mode", "description": "Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition).", "doc-url": "https://www.vuetifyjs.com/api/v-expand-x-transition#props", "default": "'in-out'", "value": { "kind": "expression", "type": "string" } } ], "events": [], "slots": [], "vue-model": { "prop": "value", "event": "input" } } ], "attributes": [ { "name": "v-mutate", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-mutate", "default": "", "required": false, "value": { "kind": "expression" }, "source": { "module": "./src/directives/index.ts", "symbol": "Mutate" }, "vue-argument": { "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-mutate#argument" }, "vue-modifiers": [ { "name": "once", "description": "Will only invoke the provided user callback once, then directive will be unbound.", "doc-url": "https://www.vuetifyjs.com/api/v-mutate#modifiers" }, { "name": "attr", "description": "Sets the value of [attributes](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserverInit/attributes) to true.", "doc-url": "https://www.vuetifyjs.com/api/v-mutate#modifiers" }, { "name": "char", "description": "Sets the value of [characterData](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserverInit/characterData) to true.", "doc-url": "https://www.vuetifyjs.com/api/v-mutate#modifiers" }, { "name": "child", "description": "Sets the value of [childList](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserverInit/childList) to true.", "doc-url": "https://www.vuetifyjs.com/api/v-mutate#modifiers" }, { "name": "sub", "description": "Sets the value of [subtree](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver/observe#Parameters) to true.", "doc-url": "https://www.vuetifyjs.com/api/v-mutate#modifiers" } ] }, { "name": "v-intersect", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-intersect", "default": "", "required": false, "value": { "kind": "expression" }, "source": { "module": "./src/directives/index.ts", "symbol": "Intersect" }, "vue-argument": { "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-intersect#argument" }, "vue-modifiers": [ { "name": "once", "description": "Will only invoke the provided user callback on mount and once intersected. If using the **quiet** modifier will only invoke once.", "doc-url": "https://www.vuetifyjs.com/api/v-intersect#modifiers" }, { "name": "quiet", "description": "Will not automatically invoke the provided callback on bind.", "doc-url": "https://www.vuetifyjs.com/api/v-intersect#modifiers" } ] }, { "name": "v-ripple", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-ripple", "default": "", "required": false, "value": { "kind": "expression" }, "source": { "module": "./src/directives/index.ts", "symbol": "Ripple" }, "vue-argument": { "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-ripple#argument" } }, { "name": "v-resize", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-resize", "default": "", "required": false, "value": { "kind": "expression" }, "source": { "module": "./src/directives/index.ts", "symbol": "Resize" }, "vue-argument": { "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-resize#argument" }, "vue-modifiers": [ { "name": "quiet", "description": "Will **not** automatically invoke the provided callback on bind.", "doc-url": "https://www.vuetifyjs.com/api/v-resize#modifiers" } ] }, { "name": "v-scroll", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-scroll", "default": "", "required": false, "value": { "kind": "expression" }, "source": { "module": "./src/directives/index.ts", "symbol": "Scroll" }, "vue-argument": { "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-scroll#argument" }, "vue-modifiers": [ { "name": "#target", "description": "The target watched for scroll changes. Defaults to window but can be changed to any valid id selector.", "doc-url": "https://www.vuetifyjs.com/api/v-scroll#modifiers" }, { "name": "self", "description": "Binds to the element that the the directive is attached.", "doc-url": "https://www.vuetifyjs.com/api/v-scroll#modifiers" } ] }, { "name": "v-touch", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-touch", "default": "", "required": false, "value": { "kind": "expression" }, "source": { "module": "./src/directives/index.ts", "symbol": "Touch" }, "vue-argument": { "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-touch#argument" } }, { "name": "v-click-outside", "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-click-outside", "default": "", "required": false, "value": { "kind": "expression" }, "source": { "module": "./src/directives/index.ts", "symbol": "Click-outside" }, "vue-argument": { "description": "", "doc-url": "https://www.vuetifyjs.com/api/v-click-outside#argument" } } ] } } }