Socket
Socket
Sign inDemoInstall

postcss-custom-properties

Package Overview
Dependencies
1
Maintainers
1
Versions
85
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    postcss-custom-properties

PostCSS plugin to polyfill W3C CSS Custom Properties for cascading variables


Version published
Maintainers
1
Install size
15.9 kB
Created

Package description

What is postcss-custom-properties?

The postcss-custom-properties npm package is a PostCSS plugin that allows you to use CSS Custom Properties (also known as CSS variables) in environments that do not support them natively. It transforms CSS variables into static values based on your configurations, making it easier to maintain themes and styles dynamically across your project.

What are postcss-custom-properties's main functionalities?

Transform CSS Custom Properties

This feature allows the transformation of CSS custom properties into their corresponding static values. It is useful for supporting older browsers that do not understand CSS variables.

/* Input CSS */
:root {
  --main-color: red;
}

a {
  color: var(--main-color);
}

/* Output CSS */
a {
  color: red;
}

Preserve option

With the preserve option set to true, the plugin outputs both the transformed static value and the original variable. This is useful for progressive enhancement.

/* Input CSS */
:root {
  --main-color: red;
}

a {
  color: var(--main-color);
}

/* Output CSS with preserve: true */
a {
  color: red;
  color: var(--main-color);
}

Other packages similar to postcss-custom-properties

Readme

Source

postcss-custom-properties Build Status

PostCSS plugin to transform W3C CSS Custom Properties for cascading variables syntax to more compatible CSS.

N.B. For now the transformation is not complete. It currently just aims to provide a future-proof way of using a limited subset of the features provided by native CSS variables.

Checkout opened issue to know the state of this plugin.

Why not postcss-vars ? Because there is already a plugin with this name that have severals bugs & untested code. But I look forward to merge those 2 plugins & deprecate this one (see opened issue).

Installation

$ npm install postcss-custom-properties

Usage

// dependencies
var fs = require("fs")
var postcss = require("postcss")
var customProperties = require("postcss-custom-properties")

// css to be processed
var css = fs.readFileSync("input.css", "utf8")

// process css using postcss-custom-properties
var output = postcss()
  .use(customProperties())
  .process(css)
  .css

Using this input.css:

:root {
  --color: red;
}

div {
  color: var(--color);
}

you will get:

div {
  color: red;
}

Checkout tests for more.

Options

preserve (default: false)

Allow you to preserve custom properties & var() usage in output.

var out = postcss()
  .use(customProperties({preserve: true}))
  .process(css)
  .css
variables (default: {})

Allow you to pass an object of variables


Contributing

Work on a branch, install dev-dependencies, respect coding style & run tests before submitting a bug fix or a feature.

$ git clone https://github.com/postcss/postcss-custom-properties.git
$ git checkout -b patch-1
$ npm install
$ npm test

Changelog

License

Keywords

FAQs

Last updated on 26 Aug 2014

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