You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@vonage/vvd-scheme

Package Overview
Dependencies
Maintainers
51
Versions
124
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vonage/vvd-scheme

Vivid scheme management service


Version published
Weekly downloads
1.1K
increased by24.77%
Maintainers
51
Created
Weekly downloads
 

Changelog

Source

2.45.0 (2024-02-21)

Features

  • icon: update icons set version to 4.5.0 (595efb2)

Readme

Source

Vivid Scheme

Scheme provides color context to Vivid components & applications. It is an integral part of packages, which are subject to the scheme's color tokens.

Scheme Featured Image

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 graph

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:

main
  • body
  • .vvd-scheme-main
  • ::part(vvd-scheme-main) - for elements within a shadow tree with a matching part attribute
alternate
  • .vvd-scheme-alternate
  • ::part(vvd-scheme-alternate) - for elements within a shadow tree with a matching part attribute

Installation

yarn add @vonage/vvd-scheme

or

npm i @vonage/vvd-scheme

Consumption

<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>

Features:

NameDescription
seta method to set the scheme. options: light, dark, syncWithOsSettings (defaults to syncWithOsSettings)
eventBusacts as EventTarget to polyfill the absence of element. can be hooked and callback upon selection - eventBus.addEventListener('vvd-scheme-select', console.log);
getSelectedSchemeget current applied scheme (light, dark)
getSelectedSchemeOptionget current option (light, dark, syncWithOsSettings)

Theme Switch

Scheme is nicely paired with the vwc-theme-switch UI component that toggles the available options.

FAQs

Package last updated on 21 Feb 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc