INSTALL.md

Installing Prefers Color Scheme

Prefers Color Scheme runs in all Node environments, with special instructions for:

• Node
• PostCSS CLI
• PostCSS Load Config
• Webpack
• Next.js
• Gulp
• Grunt

Node

Add Prefers Color Scheme to your project:

npm install postcss css-prefers-color-scheme --save-dev

Use it as a PostCSS plugin:

// commonjs
const postcss = require('postcss');
const prefersColorScheme = require('css-prefers-color-scheme');

postcss([
	prefersColorScheme(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);

// esm
import postcss from 'postcss';
import prefersColorScheme from 'css-prefers-color-scheme';

postcss([
	prefersColorScheme(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);

PostCSS CLI

Add PostCSS CLI to your project:

npm install postcss-cli css-prefers-color-scheme --save-dev

Use Prefers Color Scheme in your postcss.config.js configuration file:

const prefersColorScheme = require('css-prefers-color-scheme');

module.exports = {
	plugins: [
		prefersColorScheme(/* pluginOptions */)
	]
}

PostCSS Load Config

If your framework/CLI supports postcss-load-config.

npm install css-prefers-color-scheme --save-dev

package.json:

{
	"postcss": {
		"plugins": {
			"css-prefers-color-scheme": {}
		}
	}
}

.postcssrc.json:

{
	"plugins": {
		"css-prefers-color-scheme": {}
	}
}

See the README of postcss-load-config for more usage options.

Webpack

Webpack version 5

Add PostCSS Loader to your project:

npm install postcss-loader css-prefers-color-scheme --save-dev

Use Prefers Color Scheme in your Webpack configuration:

module.exports = {
	module: {
		rules: [
			{
				test: /\.css$/i,
				use: [
					"style-loader",
					{
						loader: "css-loader",
						options: { importLoaders: 1 },
					},
					{
						loader: "postcss-loader",
						options: {
							postcssOptions: {
								plugins: [
									// Other plugins,
									[
										"css-prefers-color-scheme",
										{
											// Options
										},
									],
								],
							},
						},
					},
				],
			},
		],
	},
};

Next.js

Read the instructions on how to customize the PostCSS configuration in Next.js

npm install css-prefers-color-scheme --save-dev

Use Prefers Color Scheme in your postcss.config.json file:

{
	"plugins": [
		"css-prefers-color-scheme"
	]
}

{
	"plugins": [
		[
			"css-prefers-color-scheme",
			{
				// Optionally add plugin options
			}
		]
	]
}

Gulp

Add Gulp PostCSS to your project:

npm install gulp-postcss css-prefers-color-scheme --save-dev

Use Prefers Color Scheme in your Gulpfile:

const postcss = require('gulp-postcss');
const prefersColorScheme = require('css-prefers-color-scheme');

gulp.task('css', function () {
	var plugins = [
		prefersColorScheme(/* pluginOptions */)
	];

	return gulp.src('./src/*.css')
		.pipe(postcss(plugins))
		.pipe(gulp.dest('.'));
});

Grunt

Add Grunt PostCSS to your project:

npm install grunt-postcss css-prefers-color-scheme --save-dev

Use Prefers Color Scheme in your Gruntfile:

const prefersColorScheme = require('css-prefers-color-scheme');

grunt.loadNpmTasks('grunt-postcss');

grunt.initConfig({
	postcss: {
		options: {
			processors: [
			prefersColorScheme(/* pluginOptions */)
			]
		},
		dist: {
			src: '*.css'
		}
	}
});