Skip to content

MyPureCloud/genesys-spark

Repository files navigation

Spark Design System

Major Version NPM latest License Documentation Figma library

⚠ Visit the V4 migration guide for details on the new v4 release and migration details.

Hi there! 👋

  • Keep reading for an overview of the Spark packages and links on how to get started installing them!
  • To see usage examples of the components with an in-browser editor visit the component playground!
  • For details on UX component documentation and guidelines, go to https://spark.genesys.com/
  • If you want to contribute to the codebase, check out the contributing guide!

Spark Packages

This project contains several packages that make up Genesys' design system, Spark.

genesys-spark

A wrapper package that serves as the default entry-point for using the design system. It provides access to custom elements loaded from a shared CDN and utilities for common UI related tasks (e.g. localization & formatting). For most use cases, this will be the only package you need.

Read more...

genesys-spark-components

A collection of custom elements and associated styles that provides a nice library of UI widgets.

Read more...

genesys-spark-visualizations

A collection of custom elements focused on charts and data visualization.

Read more...

genesys-spark-components-react

Specialized React bindings for genesys-spark-components. React doesn't always play nice with vanilla custom elements, but these bindings can help.

Read more...

genesys-spark-tokens

The set of design tokens that the Spark components and styles are built on. This is an internal package that is only used to organize development and is not published.

Read more...

Contributing and Local Development

A guide to contributing to the Genesys Spark repository

Read more...