PostCSS Prefix Wrap

✅ Supports PostCSS v7 or v8


A PostCSS plugin which prepends a selector to CSS styles to constrain their effect on parent elements in a page.

- How to use this plugin?
- What options does it have?
- How to contribute?
- Is this project secure?
- How is the project structured?
- License

How to use this plugin?

> These instructions are only for this plugin. See the PostCSS website for framework information.

$3

Using Yarn

``bash
yarn add postcss-prefixwrap --dev --exact
`

Using NPM

`bash
npm install postcss-prefixwrap --save-dev --save-exact
`

$3

Add to your PostCSS configuration.

#### With Gulp

`javascript
const Gulp = require("gulp");
const PostCSS = require("gulp-postcss");
const PrefixWrap = require("postcss-prefixwrap");

Gulp.task("css", () =>
Gulp.src("./src/*.css")
.pipe(PostCSS([PrefixWrap(".my-custom-wrap")]))
.pipe(Gulp.dest("./dest"))
);
`

#### With WebPack

`javascript
const PrefixWrap = require("postcss-prefixwrap");

module.exports = {
module: {
rules: [
{
test: /\.css$/,
use: [
"style-loader",
{ loader: "css-loader", options: { importLoaders: 1 } },
{
loader: "postcss-loader",
options: {
plugins: [PrefixWrap(".my-custom-wrap")],
},
},
],
},
],
},
};
`

> Based on example from https://webpack.js.org/loaders/postcss-loader/.

$3

Add the container to your markup.

`html



`

$3

View your CSS, now prefix-wrapped.

Before

`css
p {
color: red;
}

body {
font-size: 16px;
}
`

After

`css
.my-custom-wrap p {
color: red;
}

.my-custom-wrap {
font-size: 16px;
}
`

What options does it have?

- Minimal
- Ignored Selectors
- Prefix Root Tags
- File Whitelist
- File Blacklist

$3

The minimal required configuration is the prefix selector, as shown in the above example.

`javascript
PrefixWrap(".my-custom-wrap");
`

$3

You may want to exclude some selectors from being prefixed, this is enabled using the ignoredSelectors option.

`javascript
PrefixWrap(".my-custom-wrap", {
ignoredSelectors: [":root", "#my-id", /^\.some-(.+)$/],
});
`

$3

You may want root tags, like body and html to be converted to classes, then prefixed, this is enabled using the prefixRootTags option.

`javascript
PrefixWrap(".my-container", {
prefixRootTags: true,
});
`

With this option, a selector like html will be converted to .my-container .html, rather than the default .my-container.

$3

In certain scenarios, you may only want PrefixWrap() to wrap certain CSS files. This is done using the whitelist option.

`javascript
PrefixWrap(".my-custom-wrap", {
whitelist: ["editor.css"],
});
`

$3

In certain scenarios, you may want PrefixWrap() to exclude certain CSS files. This is done using the blacklist option.

> If whitelist option is also included, blacklist will be ignored.

`javascript
PrefixWrap(".my-custom-wrap", {
blacklist: ["colours.css"],
});
``

How to contribute?

Read our Contributing Guide to learn more about how to contribute to this project.

Is this project secure?

Read our Security Guide to learn how security is considered during the development and operation of this plugin.

How is the project structured?

Read our Architecture Document to learn how this project is structured.

License

The MIT License is used by this project.