You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

postcss-lab-function

Package Overview
Dependencies
Maintainers
3
Versions
47
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

postcss-lab-function

Use lab() and lch() color functions in CSS


Version published
Weekly downloads
5.6M
decreased by-1.43%
Maintainers
3
Install size
439 kB
Created
Weekly downloads
 

Package description

What is postcss-lab-function?

The postcss-lab-function package is a PostCSS plugin that allows you to use the CSS Lab color function in your stylesheets. This function enables you to define colors in the CIE LAB color space, which is a more perceptually uniform color space compared to RGB or HSL. This can be particularly useful for creating color schemes that are more consistent and visually appealing.

What are postcss-lab-function's main functionalities?

Convert LAB colors to RGB

This feature allows you to write colors in the LAB color space in your CSS, and the postcss-lab-function plugin will convert them to RGB for you. This makes it easier to work with LAB colors without worrying about browser compatibility.

/* Input CSS */
body {
  color: lab(54.29% 80.82 69.88);
}

/* Output CSS */
body {
  color: rgb(255, 0, 0);
}

Support for alpha transparency

This feature allows you to include an alpha transparency value in your LAB color definitions. The plugin will convert these to the appropriate RGBA values in the output CSS.

/* Input CSS */
body {
  color: lab(54.29% 80.82 69.88 / 0.5);
}

/* Output CSS */
body {
  color: rgba(255, 0, 0, 0.5);
}

Custom properties support

This feature allows you to use CSS custom properties (variables) with LAB colors. The plugin will convert the LAB colors to RGB and preserve the custom properties in the output CSS.

/* Input CSS */
:root {
  --main-color: lab(54.29% 80.82 69.88);
}
body {
  color: var(--main-color);
}

/* Output CSS */
:root {
  --main-color: rgb(255, 0, 0);
}
body {
  color: var(--main-color);
}

Other packages similar to postcss-lab-function

Readme

Source

PostCSS Lab Function PostCSS Logo

npm version Build Status Discord

Baseline Status CSS Standard Status

PostCSS Lab Function lets you use lab and lch color functions in CSS, following the CSS Color specification.

.color-lab {
	color: lab(40% 56.6 39);
}

.color-lch {
	color: lch(40% 68.735435 34.568626);
}

/* becomes */

.color {
	color: rgb(179, 35, 35);
	color: color(display-p3 0.64331 0.19245 0.16771);
}

.color-lch {
	color: rgb(179, 35, 35);
	color: color(display-p3 0.64331 0.19245 0.16771);
}

Usage

Add PostCSS Lab Function to your project:

npm install postcss postcss-lab-function --save-dev

Use it as a PostCSS plugin:

const postcss = require('postcss');
const postcssLabFunction = require('postcss-lab-function');

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

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

NodePostCSS CLIWebpackGulpGrunt

Options

preserve

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

postcssLabFunction({ preserve: true })
.color {
	color: lab(40% 56.6 39);
}

/* becomes */

.color {
	color: rgb(179, 35, 35);
	color: color(display-p3 0.64331 0.19245 0.16771);
	color: lab(40% 56.6 39);
}

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.

postcssLabFunction({ enableProgressiveCustomProperties: false })
:root {
	--firebrick: lab(40% 56.6 39);
}

/* becomes */

:root {
	--firebrick: rgb(178, 34, 34); /* will never be used, not even in older browser */
	--firebrick: color(display-p3 0.64331 0.19245 0.16771); /* will never be used, not even in older browser */
	--firebrick: lab(40% 56.6 39);
}

subFeatures

displayP3

The subFeatures.displayP3 option determines if color(display-p3 ...) is used as a fallback.
By default, it is enabled.

display-p3 can display wider gamut colors than rgb on some devices.

postcssOKLabFunction({
	subFeatures: {
		displayP3: false
	}
})
.color {
	color: lab(40% 56.6 39);
}

/* becomes */

.color {
	color: rgb(179, 35, 35);
	color: lab(40% 56.6 39);
}

This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/tree/main/css-color-4. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).

Keywords

FAQs

Package last updated on 07 Jul 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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc