Vivid API

Calendar Event

The Calendar Event component displays scheduled items within the weekly view of the Calendar component. It supports clickable, interactive events with customizable times and colors.

Usage

import { VCalendar, VCalendarEvent } from '@vonage/vivid-api-vue';
import { registerCalendar, registerCalendarEvent } from '@vonage/vivid-api';
registerCalendar('your-prefix');
registerCalendarEvent('your-prefix');

API Reference

Properties

PropertyTypeDefaultDescription
appearance'filled' | 'duotone' | 'subtle'Sets the event's appearance
connotation'alert' | 'accent' | 'cta' | 'success' | 'warning' | 'information' | 'announcement'Sets the first day of the week to display
descriptionstringSets the event description
durationnumberSets the event duration (e.g. `2` = 2 hours)
headingstringSets the event heading
overlapCountnumberSets the stacking context of the event when it overlaps with another
startnumberSets the event start time (e.g. `14` = 2pm)
PropertyTypeDefaultDescription
appearance'filled' | 'duotone' | 'subtle'Sets the event's appearance
connotation'alert' | 'accent' | 'cta' | 'success' | 'warning' | 'information' | 'announcement'Sets the first day of the week to display
descriptionstringSets the event description
durationnumberSets the event duration (e.g. `2` = 2 hours)
headingstringSets the event heading
overlap-countnumberSets the stacking context of the event when it overlaps with another
startnumberSets the event start time (e.g. `14` = 2pm)