Socket
Socket
Sign inDemoInstall

@csstools/postcss-progressive-custom-properties

Package Overview
Dependencies
5
Maintainers
3
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @csstools/postcss-progressive-custom-properties

Correctly declare progressive enhancements for CSS Custom Properties.


Version published
Weekly downloads
4.2M
increased by4.02%
Maintainers
3
Install size
75.7 kB
Created
Weekly downloads
 

Readme

Source

PostCSS Progressive Custom Properties PostCSS

NPM Version Build Status Discord

PostCSS Progressive Custom Properties is a utility plugin to correctly declare Custom Property fallbacks and enhancements.

[!WARNING] It is not intended to be used directly by stylesheet authors. Meant to be included in other PostCSS plugins that provide CSS value transforms as fallbacks.

Custom Properties are not discarded like regular declarations when invalid. This makes it tricky to provide fallback values for older browsers.

The solution is to wrap Custom Property declarations in an @supports rule.

:root {
	/* fallback */
	--a-color: red;
	/* progressive enhancement */
	--a-color: oklch(40% 0.234 0.39 / var(--opacity-50));
}

/* becomes */

:root {
	--a-color: red;
}

@supports (color: oklch(0% 0 0)) {
	:root {
		--a-color: oklch(40% 0.234 0.39 / var(--opacity-50));
	}
}

Ignored values

initial and <white space> are ignored.

.initial {
	--prop-1: red;
	--prop-1: initial;
}

.white-space {
	--prop-1: red;
	--prop-1:;

	--prop-2: red;
	--prop-2: ;

	--prop-3: red;
	--prop-3:    ;
}

/* remains */

.initial {
	--prop-1: red;
	--prop-1: initial;
}

.white-space {
	--prop-1: red;
	--prop-1:;

	--prop-2: red;
	--prop-2: ;

	--prop-3: red;
	--prop-3:    ;
}

Usage

Add PostCSS Progressive Custom Properties to your project:

npm install @csstools/postcss-progressive-custom-properties --save-dev

Use PostCSS Progressive Custom Properties as a PostCSS plugin:

const postcss = require('postcss');
const postcssCustomProperties = require('@csstools/postcss-progressive-custom-properties');

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

@supports

This plugin wraps Custom Property override declarations in an @supports rule. With PostCSS 8 this trigger declaration visitors to run again.

Make sure your plugin detects and ignores values inside relevant @supports rules.

Reading list

PostCSS Progressive Custom Properties runs in all Node environments, with special instructions for:

NodePostCSS CLIWebpackGulpGrunt

Keywords

FAQs

Last updated on 31 Mar 2024

Did you know?

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc