Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 4.31 KB

README.md

File metadata and controls

53 lines (33 loc) · 4.31 KB
Raw

Style Dictionary logo

Examples

Here you can find some sample projects to get started, or to find inspiration on how to customise and extend the Style Dictionary framework to create the files you need.

Setup

To use one of these examples, clone (or download) from GitHub the project and copy the folder of the example that you want to use. Inside the folder you will find a README.md file with the instructions on how to do the initial setup and run the build process.

You can alternatively start a new project from one of the basic or complete examples using the CLI:

$ mkdir MyFolder
$ cd MyFolder
$ style-dictionary init [example]

Where [example] is one of: basic, complete.

This will create a copy of the example in MyFolder and start the build process, running style-dictionary build for the first time to generate the artifacts.

Basic

View the example

This example code is bare-bones to show you what this framework can do. Use this if you want to play around with what the Style Dictionary can do.

Complete

View the example

This is a more complete package and should have everything you need to get started. This package can be consumed as a Cocoapod on iOS, as a node module for web, and as a local library for Android.

Advanced

View the folder

If you want to look at more advanced examples of possible applications and customisations of Style Dictionary, the examples/advanced folder on GitHub contains these extra folders:

  • assets-base64-embed shows how it's possible to embed and distribute assets – like images, icons and fonts – directly as design tokens.
  • auto-rebuild-watcher shows how to setup a "watcher" that auto-rebuilds the tokens every time there is a change in the properties.
  • custom-templates shows how to use "custom" templates to generate design tokens files with custom formats, useful when you need to distribute your design tokens and integrate them with custom pipelines or scripts.
  • custom-transforms shows how to use custom tranforms (and transformGroups) to apply custom "tranformations" to the properties when converted to design tokens.
  • multi-brand-multi-platform shows how to set up Style Dictionary to support a multi-brand (for brand theming) and multi-platform (web, iOS, Android) solution, with property values depending on brand and plaforms.
  • npm-module shows how to set up a style dictionary as an npm module, either to publish to a local npm service or to publish externally.
  • s3 shows how to set up a style dictionary to build files for different platforms (web, iOS, Android) and upload those build artifacts, together with a group of assets, to an S3 bucket.
  • referencing_aliasing shows how to use referencing (or "aliasing") to reference a value -or an attribute– of a property and assign it to the value –or attribute– of another property.

Do you think an example is missing?
Do you want to see another example added to the project?
Do you have a working example that we can add to the list?

Fantastic! Let us know by filing an issue or sending us an email: [email protected].