Colors for digital and software products using the Carbon Design System
@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
You can use the
In Sass, you can import the files individual by doing:
This file automatically includes the
carbon--colors mixin which initializes
all the color variables for the IBM Design Language.
These color variables follow the naming convention:
You can also use the shorthand form of these colors by dropping the
Note: the shorthand variables require that you do not have any other conflicting variables in your setup. Namespaced variables are always preferred for this reason, unless you are confident that no collisions will occur.
If you would like you choose when these variables are defined, then you can call
carbon--colors mixin directly by importing the following file:
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
$carbon--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
You can include this variable by including
carbon--colors() mixin directly.
Migrating from previous versions
If you were originally using a project that had color variables defined as
$ibm-color__<swatch>-<grade>, or are relying on
$ibm-color-map, you can also
use the entrypoint described above to access these colors. They are meant as an
easier way to help adopt these packages. However, these variables will be
removed in the next release of Carbon.
Similar to previous efforts, we also provide colors in the formats mentioned above. For example:
If you would like a mixin to conditionally include these variables, you can include the mixin by using:
// ESM;// CommonJSconst black blue warmGray = ;
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;blue50; // Using the `blue` object.warmGray100; // Using the `warmGray100` variable.
📖 API Documentation
If you're looking for
@carbon/colors API documentation, check out:
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! 👀
Licensed under the Apache 2.0 License.