🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

@csstools/postcss-light-dark-function

Package Overview
Dependencies
Maintainers
3
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@csstools/postcss-light-dark-function

Use the light-dark() color function in CSS

1.0.0
Source
npm
Version published
Weekly downloads
1.2M
-0.79%
Maintainers
3
Weekly downloads
 
Created
Source

PostCSS Light Dark Function PostCSS Logo

npm version Build Status Discord

Baseline Status CSS Standard Status

npm install @csstools/postcss-light-dark-function --save-dev

PostCSS Light Dark Function lets you use the light-dark color function in CSS, following the CSS Color 5 Specification.

.dark {
	color-scheme: dark;
}

.light {
	color-scheme: light;
}

.theme {
	color: light-dark(pink, magenta);
}

.prop {
	--theme-color: light-dark(cyan, deepskyblue);
}

/* becomes */

.dark {
	--csstools-color-scheme--light:  ;
	--csstools-color-scheme--dark: initial;
	color-scheme: dark;
}

.light {
	--csstools-color-scheme--light: initial;
	--csstools-color-scheme--dark:  ;
	color-scheme: light;
}

.theme {
	color: var(--csstools-color-scheme--light, pink) var(--csstools-color-scheme--dark, magenta);
	color: light-dark(pink, magenta);
}

.prop {
	--theme-color: var(--csstools-color-scheme--light, cyan) var(--csstools-color-scheme--dark, deepskyblue);
	& * {
	--theme-color: var(--csstools-color-scheme--light, cyan) var(--csstools-color-scheme--dark, deepskyblue);
	}
}

@supports (color: light-dark(red, red)) {
.prop {
	--theme-color: light-dark(cyan, deepskyblue);
}
}

:root {
	--csstools-color-scheme--light: initial;
	--csstools-color-scheme--dark:  ;
}

@media (prefers-color-scheme: dark) {

	:root {
		--csstools-color-scheme--light:  ;
		--csstools-color-scheme--dark: initial;
	}
}

Usage

Add PostCSS Light Dark Function to your project:

npm install postcss @csstools/postcss-light-dark-function --save-dev

Use it as a PostCSS plugin:

const postcss = require('postcss');
const postcssLightDarkFunction = require('@csstools/postcss-light-dark-function');

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

PostCSS Light Dark Function runs in all Node environments, with special instructions for:

Options

preserve

The preserve option determines whether the original notation is preserved. By default, it is preserved.

postcssLightDarkFunction({ preserve: false })
.dark {
	color-scheme: dark;
}

.light {
	color-scheme: light;
}

.theme {
	color: light-dark(pink, magenta);
}

.prop {
	--theme-color: light-dark(cyan, deepskyblue);
}

/* becomes */

.dark {
	--csstools-color-scheme--light:  ;
	--csstools-color-scheme--dark: initial;
	color-scheme: dark;
}

.light {
	--csstools-color-scheme--light: initial;
	--csstools-color-scheme--dark:  ;
	color-scheme: light;
}

.theme {
	color: var(--csstools-color-scheme--light, pink) var(--csstools-color-scheme--dark, magenta);
}

.prop {
	--theme-color: var(--csstools-color-scheme--light, cyan) var(--csstools-color-scheme--dark, deepskyblue);
	& * {
	--theme-color: var(--csstools-color-scheme--light, cyan) var(--csstools-color-scheme--dark, deepskyblue);
	}
}

:root {
	--csstools-color-scheme--light: initial;
	--csstools-color-scheme--dark:  ;
}

@media (prefers-color-scheme: dark) {

	:root {
		--csstools-color-scheme--light:  ;
		--csstools-color-scheme--dark: initial;
	}
}

enableProgressiveCustomProperties

The enableProgressiveCustomProperties option determines whether the original notation is wrapped with @supports when used in Custom Properties. By default, it is enabled.

[!NOTE] We only recommend disabling this when you set preserve to false or if you bring your own fix for Custom Properties.
See what the plugin does in its README.

postcssLightDarkFunction({ enableProgressiveCustomProperties: false })

Keywords

postcss-plugin

FAQs

Package last updated on 19 Feb 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts