PostCSS Environment Variables [][postcss]

[][npm-url]
[][cli-url]
[][discord]



[][css-url]
[][css-url]

[PostCSS Environment Variables] lets you use env() variables in CSS, following the [CSS Environment Variables] specification.

⚠️ Custom Environment Variables were never defined in a specification and we are no longer including this in postcss-preset-env.

In the future there might be renewed interest in Custom Environment Variables.

We advice users of this plugin to seek alternatives such as postcss-design-tokens

``css
@media (max-width: env(--branding-small)) {
body {
padding: env(--branding-padding);
}
}

/ becomes /

@media (min-width: 600px) {
body {
padding: 20px;
}
}

/* when the importFrom option is: {
"environmentVariables": {
"--branding-small": "600px",
"--branding-padding": "20px"
}
} */
`

Usage

Add [PostCSS Environment Variables] to your project:

`bash
npm install postcss postcss-env-function --save-dev
`

Use it as a [PostCSS] plugin:

`js
const postcss = require('postcss')
const postcssEnvFunction = require('postcss-env-function')

postcss([
postcssEnvFunction(/ pluginOptions /)
]).process(YOUR_CSS /, processOptions /)
`

[PostCSS Environment Variables] runs in all Node environments, with special instructions for:

| Node | PostCSS CLI | Webpack | Gulp | Grunt |
| --- | --- | --- | --- | --- |

Options

$3

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

`js
postcssEnvFunction({
importFrom: 'path/to/file.js' /* module.exports = {
environmentVariables: {
'--branding-padding': '20px',
'--branding-small': '600px'
}
} */
})
`

`css
@media (max-width: env(--branding-small)) {
body {
padding: env(--branding-padding);
}
}

/ becomes /

@media (min-width: 600px) {
body {
padding: 20px;
}
}
`

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 environmentVariables or environment-variables key.

`js
postcssEnvFunction({
importFrom: [
/* Import from a CommonJS file:

module.exports = {
environmentVariables: {
'--branding-padding': '20px'
}
} */
'path/to/file.js',

/* Import from a JSON file:

{
"environment-variables": {
"--branding-padding": "20px"
}
} */
'and/then/this.json',

/ Import from an JavaScript Object: /
{
environmentVariables: { '--branding-padding': '20px' }
},

/ Import from a JavaScript Function: /
() => {
const environmentVariables = { '--branding-padding': '20px' }

return { environmentVariables }
}
]
})
`

See example imports written in JS and JSON.
Currently only valid [custom property names] (beginning with --) are accepted.
Not all valid [declaration value names] are accepted.

$3

Silence the deprecation notice that is printed to the console when using importFrom``.

> postcss-env-function is deprecated and will be removed.
> Check the discussion on github for more details. https://github.com/csstools/postcss-plugins/discussions/192

[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
[css-url]: https://cssdb.org/#environment-variables
[discord]: https://discord.gg/bUadyRwkJS
[npm-url]: https://www.npmjs.com/package/postcss-env-function

[CSS Environment Variables]: https://drafts.csswg.org/css-env-1/
[PostCSS]: https://github.com/postcss/postcss
[PostCSS Environment Variables]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-env-function

[custom property names]: https://drafts.csswg.org/css-variables-1/#typedef-custom-property-name
[declaration value names]: https://drafts.csswg.org/css-syntax-3/#typedef-declaration-value