css-modulesify

A browserify transform 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.

Usage

First install the package: npm install --save css-modulesify

Then you can use it as a browserify transform, eg: browserify -t css-modulesify 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>`;

To add the css to the html page there are 2 easy options:

• add the css to the DOM at runtime (good for component-based css): require('insert-css')(require('./styles.css'))
• export a static css file at build-time: browserify -t css-modulesify example/export-css.js | node > bundle.css

Example

Take a look at the example for more details, or inspect the source.

Licence

MIT

With thanks

• Tobias Koppers
• Mark Dalgleish
• Glen Maddern

Josh Johnston, 2015.