Vivid API

Note

Callout information that would be relevant to the user.

Usage

import { registerNote } from '@vonage/vivid-api';
registerNote('your-prefix');

Slots

Default Slot

Any slotted content will appear below the headline.

Icon Slot

Set the icon slot to show an icon before the note’s headline.
If set, the icon(deprecated) attribute is ignored.

API Reference

Properties

PropertyTypeDefaultDescription
connotation'accent' | 'success' | 'alert' | 'warning' | 'information' | 'announcement'
headlinestringSets the headline text
PropertyTypeDefaultDescription
connotation'accent' | 'success' | 'alert' | 'warning' | 'information' | 'announcement'
headlinestringSets the headline text

Slots

NameDescription
defaultAny slotted content will appear below the headline.
iconThe preferred way to add an icon to the component.
NameDescription
defaultAny slotted content will appear below the headline.
iconThe preferred way to add an icon to the component.