Back to Vuetify

Vuetify Labs

packages/docs/src/pages/en/labs/introduction.md

4.2.03.7 KB
Original Source

Vuetify Labs

Experiment and use in-development components before they're released.

<PageFeatures />

What is Labs? { id=what-is-labs }

Labs is a new way for developers to use unfinished components in an alpha state.

::: error Components available through Labs are considered NOT production ready and only to be used for testing purposes. Breaking changes will be introduced in patch releases and no support will be provided. :::

Usage

Using a Labs component is as simple as importing from vuetify/labs. The following example shows how to import and bootstrap v-month-picker in your component:

html
<template>
  <v-month-picker />
</template>

<script setup>
  import { VMonthPicker } from 'vuetify/labs/VMonthPicker'
</script>

Alternatively you can make the component available globally by importing it in your Vuetify plugin file:

js
import { createVuetify } from 'vuetify'
import { VMonthPicker } from 'vuetify/labs/VMonthPicker'

export default createVuetify({
  components: {
    VMonthPicker,
  },
})

When Vuetify instantiates it will register VMonthPicker as a usable component within templates.

If you wish to install all available Vuetify components use the following code snippet:

js
import { createVuetify } from 'vuetify'
import * as components from 'vuetify/components'
import * as labsComponents from 'vuetify/labs/components'

export default createVuetify({
  components: {
    ...components,
    ...labsComponents,
  },
})
<PromotedEntry />

Available Components

The following is a list of available and up-and-coming components for use with Labs:

ComponentDescriptionMin Version
v-pieA component to display data as interactive pie/donut chartv3.9.3
v-videoA customizable wrapper for native video elementv3.9.3
v-avatar-groupA component to group and display multiple avatarsv3.12.0
v-command-paletteA searchable command palette componentv3.12.0
v-progressA unified progress indicator component with a11y defaultsv4.0.3
v-date-range-pickerA dual-month range picker componentv4.1.0
v-heatmapA component to display data as a colored gridv4.1.0
v-highlightRenders text with highlighted search matchesv4.1.0
v-month-pickerA month and year picker componentv4.1.0

::: warning Lab component APIs are NOT finalized and can and will change. You should EXPECT for things to break during the course of development. :::