Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@vonage/vvd-scheme
Advanced tools
This package is imported and executed by default in all core dependent packages but can also be consumed on its own. By default, (if not explicitly defined otherwise by the consumer) scheme will result in the user's preferred os option (light|dark|auto)
Each scheme will provide the same exact color tokens to support main context and its alternating - contrasting - context (e.g. sidenav, top-bar etc'...). Once imported and set, these tokens are reflected as CSS variables.
Scheme will apply main context on body selector and will never apply alternate unless explicitly set. To also be able to modify HTML scopes manually in apps, we include the following css selectors:
body
.vvd-scheme-main
::part(vvd-scheme-main)
- for elements within a shadow tree with a matching part attribute.vvd-scheme-alternate
::part(vvd-scheme-alternate)
- for elements within a shadow tree with a matching part attributeyarn add @vonage/vvd-scheme
or
npm i @vonage/vvd-scheme
<script type="module" src="../node_modules/@vonage/scheme/vvd-scheme.js"></script>
or
import scheme from '@vonage/vvd-scheme';
As colors are critical identities of our style, it's advised to include a link type:modulepreload to hint the browser of the module importance, its high priority and preemptively fetch it.
<script rel="modulepreload" src="../node_modules/@vonage/scheme/vvd-scheme.js"></script>
Name | Description |
---|---|
set | a method to set the scheme. options: light, dark, syncWithOsSettings (defaults to syncWithOsSettings) |
eventBus | acts as EventTarget to polyfill the absence of element. can be hooked and callback upon selection - eventBus.addEventListener('vvd-scheme-select', console.log); |
getSelectedScheme | get current applied scheme (light, dark) |
getSelectedSchemeOption | get current option (light, dark, syncWithOsSettings) |
Scheme is nicely paired with the vwc-theme-switch UI component that toggles the available options.
2.22.1 (2021-11-05)
FAQs
Vivid scheme management service
The npm package @vonage/vvd-scheme receives a total of 431 weekly downloads. As such, @vonage/vvd-scheme popularity was classified as not popular.
We found that @vonage/vvd-scheme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 51 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.