Swarm-constants NPM

swarm-constants

This project contains cross-platform "design constants" for the Swarm Design System, generated using style-dictionary;

Documentation

Documentation is generated from properties/ and published on github pages:

Colors
more to come...

Using `swarm-constants` in your application

See the dist/ directory for platfrom-specific distributions.

Currently supported distributions

static docs
android (colors)
scss

Development

Modifying or adding values

Edit json files in properties/. Please use the "Category/Type/Item" convention for object structure. Colors should be expressed as an rgba array, [R,G,B,A].

Adding distributions

The style-dictionary library uses a config.json file to configure distributions. You can use one of the built in formats provided by style-dictionary, or you can register your own format.

Scripts

We commit our distributions to make it easier for consumers to import design constants. To regenerate distributions, use command yarn run build.

Command	Result
`yarn run build`	Compiles distributions

Release notes

v1.2.X

buttonBG, and all variants of fieldBG have been removed after the design team re-styled form inputs and buttons. You can use coolGrayLightTransp in place of buttonBG, but there's no replacement for fieldBG or its variants.