@wordpress/base-styles

Base Styles

Base SCSS utilities and variables for WordPress.

Installation

Install the module

npm install @wordpress/base-styles --save-dev

Use

SCSS utilities and variables

In your application's SCSS file, include styles like so:

@import 'node_modules/@wordpress/base-styles/colors';
@import 'node_modules/@wordpress/base-styles/variables';
@import 'node_modules/@wordpress/base-styles/mixins';
@import 'node_modules/@wordpress/base-styles/breakpoints';
@import 'node_modules/@wordpress/base-styles/animations';
@import 'node_modules/@wordpress/base-styles/z-index';
@import 'node_modules/@wordpress/base-styles/default-custom-properties';

If you use Webpack for your SCSS pipeline, you can use ~ to resolve to node_modules:

@import '~@wordpress/base-styles/colors';

To make that work with sass or node-sass NPM modules without Webpack, you'd have to use includePaths option:

{
	"includePaths": [ "node_modules" ]
}

CSS Admin Themes

The package also includes a built version of the output generated by the wordpress-admin-schemes() mixin which can be used directly in your project. The CSS file is located at node_modules/@wordpress/base-styles/build-style/admin-schemes.css.

Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.