@vonage/vvd-context

Introduction

Vivid components are fully taking care of their styling. Yet there are also a simple native HTML elements, that should also comply with the Vivid Design System.

For this reason we are providing Vivid Context service, responsible of mounting the Vivid styling into a document.

The service is optional, but most likely will be needed in any Vonage application.

Attention! vvd-context uses internally vvd-core, which sets up the core services like theming and typography, thus vvd-context user may safely omit any own setup of the core.

API

Attention! As an initial step, to provide smoother migration and lesser friction with an existing systems (especially those heavily dependent on Volta's legacy), we are scoping most of the Vivid context impact by special class: vivid-scope.

Please, put vivid-scope class at the root of the DOM tree, that is ready to be styled by Vivid.

Any new application should just safely put that class on the application DOM root (usually body).

mount(target)

Description:

Mounts Vivid context (styles) into the target scope / document. Default target is the document visible in the current scope. The API is idempotent, the style/s will be mounted only once, even if API called multiple times.

Params:

• target - Document or DocumentFragment (including ShadowRoot); optional; defaults to document

Throws:

• if the provided target argument is null or not of a type Document or DocumentFragment

Examples

Import

import vvdContext from '@vonage/vvd-context';

Mount context into the current document scope

vvdContext.mount();

Mount context into a document of choice

const shadowRoot = someElement.shadowRoot;
vvdContext.mount(shadowRoot);

Changelog

2.30.0 (2022-05-08)

Bug Fixes

• menu: background and shadow colors (#1280) (40e02cd)

Features

• breadcrumb: add the breadcrumb component (#1260) (bf0c5ed)