@rolemodel/optics v1.0.0
Optics, a RoleModel Design System
Optics is an scss package that provides base styles and components that can be integrated and customized in a variety of projects.
Installation
NPM
npm install @rolemodel/opticsYarn
yarn add @rolemodel/opticsImport
If you are using webpack to compile, you can add this import to the top of your root level scss file.
@import '@rolemodel/optics';If you are using a different compiler such as Dart Sass, you may need to reference the scss file directly.
@import '@rolemodel/optics/dist/scss/optics';Documentation
We use Storybook as a way to provide informative and interactive documentation.
It can be found here Optics Documentation
Token Documentation
We use the Storybook Design Token for showing design tokens in the documentation. This allows us to tag groups of tokens with a category and a presenter.
Add the following above a group to categorize the tokens.
/**
* @tokens Basic Colors
* @presenter Color
*/Component Documentation
For instructions on how to create a new component, see Process for Creating New Components
Additional stories can be added using the following command, or copying an existing story.
npm run generateThe visual graphic found on the Selective Imports page in the documentation is generated from the tools/generate-graph.dot file. You can preview and export a newer svg version of the graphic by using the tintinweb.graphviz-interactive-preview VSCode extension.