Vivid API

Tags

Tags are small, interactive labels used to visually group, classify, or filter criteria. Tags are wrapped with Tag Group

Usage

import { VTag, VTagGroup } from '@vonage/vivid-api-vue';
import { registerTag, registerTagGroup } from '@vonage/vivid-api';
registerTag('your-prefix');
registerTagGroup('your-prefix');

Slots

Icon Slot

Use the icon slot in the Tag component to customise icons. If set, the icon attribute is ignored.

API Reference

tag-group

Slots

NameDescription
defaultThe content of the tag-group.
NameDescription
defaultThe content of the tag-group.

tag

Properties

PropertyTypeDefaultDescription
appearance'duotone' | 'subtle' | 'subtle-light'The appearance the tag should have.
connotation'alert' | 'accent' | 'cta' | 'success' | 'warning' | 'information' | 'announcement'The connotation the tag should have.
disabledbooleanindicates whether the tag is disabled
labelstringIndicates the tag's label.
removablebooleanindicates whether the tag is removable
selectablebooleanindicates whether the tag is selectable
selectedbooleanindicates whether the tag is selected
shape'rounded' | 'pill'The shape the tag should have.
PropertyTypeDefaultDescription
appearance'duotone' | 'subtle' | 'subtle-light'The appearance the tag should have.
connotation'alert' | 'accent' | 'cta' | 'success' | 'warning' | 'information' | 'announcement'The connotation the tag should have.
disabledbooleanindicates whether the tag is disabled
labelstringIndicates the tag's label.
removablebooleanindicates whether the tag is removable
selectablebooleanindicates whether the tag is selectable
selectedbooleanindicates whether the tag is selected
shape'rounded' | 'pill'The shape the tag should have.

Slots

NameDescription
iconThe preferred way to add an icon to the component.
NameDescription
iconThe preferred way to add an icon to the component.

Events

NameTypeDescription
removedCustomEvent<undefined>Fires when the tag is removed
selected-changeCustomEvent<undefined>Fires when the selected state changes
NameTypeDescription
removedCustomEvent<undefined>Fires when the tag is removed
selected-changeCustomEvent<undefined>Fires when the selected state changes

Methods

NameParamsReturnsDescription
removevoid