@carbon/colors

@carbon/colors

Colors for digital and software products using the Carbon Design System

Getting started

To install @carbon/colors in your project, you will need to run the following command using npm:

npm install -S @carbon/colors

If you prefer Yarn, use the following command instead:

yarn add @carbon/colors

Usage

You can use the @carbon/colors module in your JavaScript, in addition to your Sass.

Sass

In Sass, you can import the files individual by doing:

@use '@carbon/colors';

// Another way if using `@carbon/react
@use '@carbon/react/scss/colors';

These color variables follow the naming convention: <swatch>-<grade>. For example:

colors.$blue-50;
colors.$cool-gray-10;
colors.$black-100;
colors.$white-0;

Alongside the color variables detailed above, we also provide a map of colors so that you can programmatically use these values. This map is called $colors and each key is the name of a swatch. The value of these swatches is also a map, but each key is now the grade. In code, this looks like the following:

$colors: (
  'blue': (
    10: #edf4ff,
    // ...
  )
);

JavaScript

For JavaScript, you can import and use this module by doing the following in your code:

// ESM
import { black, blue, warmGray } from '@carbon/colors';

// CommonJS
const { black, blue, warmGray } = require('@carbon/colors');

Each color swatch is exported as a variable, and each color name is also exported as an object that can be called by specifying grade, for example:

black;
blue[50]; // Using the `blue` object.
warmGray100; // Using the `warmGray100` variable.

Examples

If you're looking for more examples on how to use @carbon/colors, we have some examples that you can check out:

• sass-modules

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!

Modifying color values

Color values are defined in src/dtcg/colors.json using the DTCG token format. This is the single source of truth for the package — do not edit generated files directly.

The following files are generated at build time by Style Dictionary and should not be hand-edited:

• js/generated/colors.js / js/generated/colors.d.ts — JS exports
• scss/ — Sass variables and maps

To add or update a color:

1. Edit src/dtcg/colors.json
2. Run yarn build in this package to regenerate all outputs
3. Run yarn test --testPathPatterns=packages/colors from the repo root to confirm nothing regressed

License

Licensed under the Apache 2.0 License.

IBM Telemetry

This package uses IBM Telemetry to collect de-identified and anonymized metrics data. By installing this package as a dependency you are agreeing to telemetry collection. To opt out, see Opting out of IBM Telemetry data collection. For more information on the data being collected, please see the IBM Telemetry documentation.