open-index/open-npm huggingface dataset:
npm package: @stead/themes
Description: Themes for applying color in the Stead Design System
Latest version: 0.1.9

# @stead/themes

> Themes for applying color in the Stead Design System

## Getting started

To install `@stead/themes` in your project, you will need to run the following
command using [npm](https://www.npmjs.com/):

```bash
npm install -S @stead/themes
```

If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
instead:

```bash
yarn add @stead/themes
```

## Usage

You can use `@stead/themes` in JavaScript or Sass by including this package in
your project. By default, `@stead/themes` provides a set of color tokens that
are pre-defined for a specific theme. Currently, we offer the following color
themes: white, gray 10, gray 90, gray 100 .

You can preview all of the token values for this on the
[Stead Design System website](https://next.carbondesignsystem.com/guidelines/color/usage)
.

### Sass

If you're project is using Sass, you can include this package and the
corresponding default theme by writing the following in your Sass file:

```scss
@import '@stead/themes/scss/themes';
```

By default, the white theme will be initialized. If you would like to include
another theme, you can do so by calling our mixin. For example:

```scss
@import '@stead/themes/scss/themes';

// Use the gray 10 theme
@include stead--theme($stead--theme--g10);

// Use the gray 90 theme
@include stead--theme($stead--theme--g90);

// Use the gray 100 theme
@include stead--theme($stead--theme--g100);
```

Alternatively, you can set the global theme variable then call the mixin without
passing in a theme name.

```scss
@import '@stead/themes/scss/themes';

$stead--theme: $stead--theme--g10;

// Use the gray 10 theme
@include stead--theme();
```

Inline theming can be done by using the mixin. For example:

```scss
@import '@stead/themes/scss/themes';

// Use the default white theme here

.my-dark-theme {
  @include stead--theme($stead--theme--g90) {
    // Use the dark theme here
  }
}

.my-darker-theme {
  @include stead--theme($stead--theme--g100) {
    // Use the darker theme here
  }
}
```

### JavaScript

If you're looking to use these themes in JavaScript, we export a variety of
bindings for you to use, including:

```js
import {
  // An object of all themes
  themes,

  // Direct theme values
  white,
  g10,
  g90,
  g100,

  // Specific token values
  interactive01,
  interactive02,
} from '@stead/themes';
```

## 📖 API Documentation

If you're looking for `@stead/themes` API documentation, check out:

- [Sass](./docs/sass.md)

## 🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features,
or help us improve the project documentation. If you're interested, definitely
check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀

## 📝 License

Licensed under the [Apache 2.0 License](/LICENSE).