postcss-custom-properties
Use Custom Properties Queries in CSS
Last updated 3 months ago by jonathantneal .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install postcss-custom-properties 
SYNC missed versions from official npm registry.

PostCSS Custom Properties PostCSS

NPM Version CSS Standard Status Build Status Support Chat

PostCSS Custom Properties lets you use Custom Properties in CSS, following the CSS Custom Properties specification.

:root {
  --color: red;
}

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

/* becomes */

:root {
  --color: red;
}

h1 {
  color: red;
  color: var(--color);
}

Usage

Add PostCSS Custom Properties to your project:

npm install postcss-custom-properties --save-dev

Use PostCSS Custom Properties to process your CSS:

const postcssCustomProperties = require('postcss-custom-properties');

postcssCustomProperties.process(YOUR_CSS /*, processOptions, pluginOptions */);

Or use it as a PostCSS plugin:

const postcss = require('postcss');
const postcssCustomProperties = require('postcss-custom-properties');

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

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

Node PostCSS CLI Webpack Create React App Gulp Grunt

Options

preserve

The preserve option determines whether Custom Properties and properties using custom properties should be preserved in their original form. By default, both of these are preserved.

postcssCustomProperties({
  preserve: false
});
:root {
  --color: red;
}

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

/* becomes */

h1 {
  color: red;
}

importFrom

The importFrom option specifies sources where Custom Properties can be imported from, which might be CSS, JS, and JSON files, functions, and directly passed objects.

postcssCustomProperties({
  importFrom: 'path/to/file.css' // => :root { --color: red }
});
h1 {
  color: var(--color);
}

/* becomes */

h1 {
  color: red;
}

Multiple sources can be passed into this option, and they will be parsed in the order they are received. JavaScript files, JSON files, functions, and objects will need to namespace Custom Properties using the customProperties or custom-properties key.

postcssCustomProperties({
  importFrom: [
    'path/to/file.css',   // :root { --color: red; }
    'and/then/this.js',   // module.exports = { customProperties: { '--color': 'red' } }
    'and/then/that.json', // { "custom-properties": { "--color": "red" } }
    {
      customProperties: { '--color': 'red' }
    },
    () => {
      const customProperties = { '--color': 'red' };

      return { customProperties };
    }
  ]
});

See example imports written in CSS, JS, and JSON.

exportTo

The exportTo option specifies destinations where Custom Properties can be exported to, which might be CSS, JS, and JSON files, functions, and directly passed objects.

postcssCustomProperties({
  exportTo: 'path/to/file.css' // :root { --color: red; }
});

Multiple destinations can be passed into this option, and they will be parsed in the order they are received. JavaScript files, JSON files, and objects will need to namespace Custom Properties using the customProperties or custom-properties key.

const cachedObject = { customProperties: {} };

postcssCustomProperties({
  exportTo: [
    'path/to/file.css',   // :root { --color: red; }
    'and/then/this.js',   // module.exports = { customProperties: { '--color': 'red' } }
    'and/then/this.mjs',  // export const customProperties = { '--color': 'red' } }
    'and/then/that.json', // { "custom-properties": { "--color": "red" } }
    cachedObject,
    customProperties => {
      customProperties    // { '--color': 'red' }
    }
  ]
});

See example exports written to CSS, JS, MJS, and JSON.

Current Tags

  • 9.0.2                                ...           latest (3 months ago)

43 Versions

  • 9.0.2                                ...           3 months ago
  • 9.0.1                                ...           4 months ago
  • 8.0.11                                ...           4 months ago
  • 8.0.10                                ...           7 months ago
  • 8.0.9                                ...           a year ago
  • 8.0.8                                ...           a year ago
  • 8.0.7                                ...           a year ago
  • 8.0.6                                ...           a year ago
  • 8.0.5                                ...           a year ago
  • 8.0.4                                ...           a year ago
  • 8.0.3                                ...           a year ago
  • 8.0.2                                ...           a year ago
  • 8.0.1                                ...           a year ago
  • 8.0.0                                ...           a year ago
  • 7.0.0                                ...           2 years ago
  • 6.3.1                                ...           2 years ago
  • 6.3.0                                ...           2 years ago
  • 6.2.0                                ...           2 years ago
  • 6.1.0                                ...           2 years ago
  • 6.0.1                                ...           2 years ago
  • 6.0.0                                ...           2 years ago
  • 5.0.2                                ...           3 years ago
  • 5.0.1                                ...           3 years ago
  • 5.0.0                                ...           4 years ago
  • 4.2.0                                ...           4 years ago
  • 4.1.0                                ...           4 years ago
  • 4.0.0                                ...           4 years ago
  • 3.3.0                                ...           5 years ago
  • 3.2.0                                ...           5 years ago
  • 3.1.0                                ...           5 years ago
  • 3.0.1                                ...           5 years ago
  • 3.0.0                                ...           5 years ago
  • 2.1.1                                ...           5 years ago
  • 2.1.0                                ...           5 years ago
  • 2.0.0                                ...           5 years ago
  • 1.0.2                                ...           5 years ago
  • 1.0.1                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
  • 0.4.0                                ...           5 years ago
  • 0.3.1                                ...           5 years ago
  • 0.3.0                                ...           5 years ago
  • 0.2.0                                ...           5 years ago
  • 0.1.0                                ...           5 years ago
Downloads
Today 57
This Week 57
This Month 44,249
Last Day 832
Last Week 18,453
Last Month 74,029
Dependencies (2)
Dev Dependencies (9)
Dependents (218)

Copyright 2014 - 2016 © taobao.org |