Skip to content

optics 0.4.0

Install from the command line:
Learn more about npm packages
$ npm install @rolemodel/optics@0.4.0
Install via package.json:
"@rolemodel/optics": "0.4.0"

About this version

Optics, a RoleModel Design System

Linting CI

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

Yarn

yarn add @rolemodel/optics

Import

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.

Available Presenters

Add the following above a group to categorize the tokens.

/**
* @tokens Basic Colors
* @presenter Color
*/

Component Documentation

Additional stories can be added using the following command, or copying an existing story.

npm run generate

License

MIT

Details


Assets

  • optics-0.4.0.tgz

Download activity

  • Total downloads 38
  • Last 30 days 0
  • Last week 0
  • Today 0