Files
directus/docs/reference/app/components/v-chip.md
Nitwel c2e7c85bbd Update documentation of app (#4222)
* move component docs to documentation

* update app docs tables for components

* update docs

* Add components to docs sidebar

* fix generated tables

* fix tables

* rename transitions

* update tables

* update nested components

* update tables

* update tables

* update tables

* update v-table table

* add basic documentation to each component

* remove all stories of storybook

* add missing documentation

* undate tables

* update tables

* update docs sidebar

* update app docs

* remove unused references

* add general readme

* update docs

* make reference titiles smaller

* add reference tag

* improve docs

* update order of tabs in sidebar

* remove all readmes and stories from interfaces/displays

* Cleanup menu

* Remove storybook

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-24 17:48:19 -05:00

3.6 KiB

Chip

Chips are small round components that can be used to display tags or similar data.

<v-chip>I'm a chip!</v-chip>

Sizes

The chip component supports the following sizes through the use of props:

  • x-small
  • small
  • (default)
  • large
  • x-large
<v-chip x-small>I'm a chip!</v-chip>

Colors

You can set the color, background color, hover color, and background hover color with the --v-chip-color, --v-chip-background-color, --v-chip-color-hover, and --v-chip-background-color-hover css variables respectively:

<v-chip>I'm a chip!</v-chip>
<style>
	.v-chip {
		--v-chip-color: var(--red);
		--v-chip-background-color: var(--red-50);
		--v-chip-color-hover: var(--white);
		--v-chip-background-color-hover: var(--red);
	}
</style>

Clicks / Closes

There are two events, one when clicking on the chip called click and one when clicking on the enabled close icon called close.

<v-chip @click="sayHi">Hello!</v-chip>
<v-chip close @close="close">I'm closeable!</v-chip>

Reference

Props

Prop Description Default Type
active Change visibility. Can be reacted to via sync null Boolean
close Displays a close icon which triggers the close event false Boolean
close-icon Which icon should be displayed instead of close 'close' String
outlined false Boolean
label true Boolean
disabled false Boolean
outlined No background false Boolean
label Label style true Boolean
disabled Disabled state false Boolean
close-icon 'close' String

Slots

Slot Description Data
default --

Events

Event Description Value
click Triggers when clicked somewhere on the chip
close Triggers when the close prop is enabled and gets clicked (Doesn't trigger the click event)
update:active

CSS Variables

Variable Default
--v-chip-color var(--foreground-normal)
--v-chip-background-color var(--background-normal-alt)
--v-chip-color-hover var(--white)
--v-chip-background-color-hover var(--primary-125)
--v-chip-close-color var(--danger)
--v-chip-close-color-disabled var(--primary)
--v-chip-close-color-hover var(--primary-125)