css-modulesify
A browserify plugin to load CSS Modules.
Please note that this is still highly experimental.
Why CSS Modules?
Normally you need to use a strict naming convention like BEM to ensure that one component's CSS doesn't collide with another's. CSS Modules are locally scoped, which allows you to use names that are meaningful within the context of the component, without any danger of name collision.
Read Mark Dalgleish's excellent "End of Global CSS" and check out css-modules for more context.
Getting started
First install the package: npm install --save css-modulesify
Then you can use it as a browserify plugin, eg: browserify -p [ css-modulesify -o dist/main.css ] example/index.js
Inside example/index.js you can now load css into your scripts. When you do var box1 = require('./box1.css'), box1 will be an object to lookup the localized classname for one of the selectors in that file.
So to apply a class to an element you can do something like:
var styles = require('./styles.css');
var div = `<div class="${styles.inner}">...</div>`;
The generated css will contain locally-scoped versions of any css you have require'd, and will be written out to the file you specify in the --output or -o option.
API Usage
var b = require('browserify')();
b.add('./main.js');
b.plugin(require('css-modulesify'), {
rootDir: __dirname,
output: './path/to/my.css'
});
b.bundle();
// or, get the output as a stream
var b = require('browserify')();
var fs = require('fs');
b.add('./main.js');
b.plugin(require('css-modulesify'), {
rootDir: __dirname
});
var bundle = b.bundle()
b.on('css stream', function (css) {
css.pipe(fs.createWriteStream('mycss.css'));
});
Options:
rootDir: absolute path to your project's root directory. This is optional but providing it will result in better generated classnames. css-modulesify will try to use the browserifybasedirifrootDiris not specified, if both are not specified it will use the location from which the command was executed.output: path to write the generated css. If not provided, you'll need to listen to the'css stream'event on the bundle to get the output.jsonOutput: optional path to write a json manifest of classnames.use: optional array of postcss plugins (by default we use the css-modules core plugins). NOTE: it's safer to useafterbefore: optional array of postcss plugins to run before the required css-modules core plugins are run.after: optional array of postcss plugins to run after the required css-modules core plugins are run.generateScopedName: (API only) a function to override the default behaviour of creating locally scoped classnames.global: optional boolean. Set totrueif you wantcss-modulesifyto apply tonode_modulesas well as local files. You can read more about it in the browserify docs.filePattern: optional regular expression string to specify css file names. (default:\.css$)cache: optional object to persist cache between runs.
Events
b.on('css stream', callback)The callback is called with a readable stream containing the compiled CSS. You can write this to a file.
Using CSS Modules on the backend
If you want to use CSS Modules in server-generated templates there are a couple of options:
-
Option A (nodejs only): register the require-hook so that
var styles = require('./foo.css')operates the same way as on the frontend. Make sure that therootDiroption matches to guarantee that the classnames are the same. -
Option B: configure the
jsonOutputoption with a file path andcss-modulesifywill generate a JSON manifest of classnames.
PostCSS Plugins
The following PostCSS plugins are enabled by default:
- postcss-modules-local-by-default
- postcss-modules-extract-imports
- postcss-modules-scope
- postcss-modules-values
(i.e. the CSS Modules specification).
You can override the default PostCSS Plugins (and add your own) by passing --use|-u to css-modulesify.
Or if you just want to add some extra plugins to run after the default, add them to the postcssAfter array option (API only at this time). In the same way, add extra plugins to postcssBefore to run the before the defaults.
In addition you may also wish to configure defined PostCSS plugins by passing --plugin.option true.
An example of this would be:
browserify -p [css-modulesify \
--after autoprefixer --autoprefixer.browsers '> 5%' \
-o dist/main.css] -o dist/index.js src/index.js
Building for production
If you set NODE_ENV=production then css-modulesify will generate shorter (though less useful) classnames.
You can also manually switch to short names by setting the generateScopedName option. Eg:
browserify.plugin(cssModulesify, {
rootDir: __dirname,
output: './dist/main.css',
generateScopedName: cssModulesify.generateShortName
})
Example
An example implementation can be found here.
Licence
MIT
With thanks
- Tobias Koppers
- Mark Dalgleish
- Glen Maddern
Josh Johnston, 2015.
22.7k Jan 3, 2023
1.1k Jan 2, 2023
11.1k Jan 8, 2023
5.8k Dec 31, 2022
5.3k Jan 1, 2023
104 Dec 8, 2022
210 Dec 13, 2022
111 Dec 22, 2022
110 Dec 24, 2022
7 Mar 26, 2022
117 May 26, 2021
96 Dec 10, 2022
161k Jan 1, 2023
46.6k Dec 31, 2022
63.5k Dec 30, 2022
38.8k Jan 2, 2023
32.1k Jan 4, 2023
11.3k Jan 4, 2023
11.6k Jan 3, 2023