@automattic/calypso-color-schemes

Calypso Color Schemes

This package contains a number of CSS custom properties used in Calypso.

Installation

yarn add @automattic/calypso-color-schemes

Usage

Using the CSS output

Add this packages CSS from css/index.css in order to access the CSS custom properties.

When importing, you can do

import '@automattic/calypso-color-schemes';

And this will give you the CSS.

If you want only the :root rules without all the schemes, you can do

import '@automattic/calypso-color-schemes/root-only';

Using the JS output

Sometimes, calypso-color-schemes properties are consumed in JavaScript. To avoid parsing CSS syntax on your own, or to help postcss-custom-properties use them without parsing the CSS (much faster), use the JS output as follows:

import { customProperties } from '@automattic/calypso-color-schemes/js'; // mind the js suffix

Or with postcss-custom-properties, and postcss.config.js can look like this:

module.exports = () => ( {
	plugins: {
		'postcss-custom-properties': {
			importFrom: [ require.resolve( '@automattic/calypso-color-schemes/js' ) ],
		},
	},
} );

Note on using the JS output

The CSS files include variable definitions for all Calypso color schemes (Classic Blue, Contrast, Midnight, ...), but the JS exports include only variables from the :root selector, i.e., only the fallback default theme.