@okta/nim

@okta/nim

This package provides the necessary SCSS and fonts to utilize Nim, Okta's design system.

For guidance on how and when to implement individual components, please see our online docs.

What's Included

dist/nim.css - A precompiled version of Nim for those who don't need the benefits of Sass.

src/scss - The SCSS source files for Nim, ready to be @import'd into your project.

src/scss/nim.scss - The main compilation sheet for Nim.

Getting Started

Install Nim

Using yarn:

$ yarn add @okta/nim

If you prefer npm, use the following command instead:

$ npm install --save @okta/nim

SCSS

Usage of the Nim Sass files assumes the use of a SCSS pre-processor. All Sass files use the *.scss file extension and syntax.

Autoprefixer

Make sure your asset pipeline utilizes autoprefixer to ensure vendor prefixes are automatically added to your compiled CSS.

Importing SCSS files

To add a Nim to your build, import the compilation sheet directly.

@import 'node_modules/nim/src/scss/nim';

This will import all functions, mixins, abstracts, components, and layouts into your build.

If you are looking for a more limited selection, you can also import select components, etc individually.

Contributing

Linting

Nim utilizes stylelint for our live linting as well as our lint tests.

You can check the current syntax rule configuration in stylelint.json.