Vivid API

Progress Ring

Use to display the length of time a process will take, visualize a percentage value (determinate) or to represent an unspecified wait time (indeterminate).

Usage

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

API Reference

Properties

PropertyTypeDefaultDescription
connotation'accent' | 'cta' | 'success' | 'alert'
maxnumberThe maximum value
minnumberThe minimum value
pausedbooleanIndicates the progress is paused
size0 | 1 | -1 | 2 | 3 | 4 | 5 | -6 | -5 | -4 | -3 | -2
valuenumberThe value of the progress
PropertyTypeDefaultDescription
connotation'accent' | 'cta' | 'success' | 'alert'
maxnumberThe maximum value
minnumberThe minimum value
pausedbooleanIndicates the progress is paused
size0 | 1 | -1 | 2 | 3 | 4 | 5 | -6 | -5 | -4 | -3 | -2
valuenumberThe value of the progress