Socket
Socket
Sign inDemoInstall

@csstools/postcss-light-dark-function

Package Overview
Dependencies
Maintainers
3
Versions
14
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


Version published
Weekly downloads
641K
increased by6.98%
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--dark: initial;
	color-scheme: dark;
}

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

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

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

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

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--dark: initial;
	color-scheme: dark;
}

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

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

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

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

FAQs

Package last updated on 01 Apr 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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc