Nourishing Pizza Microservice
    Have ideas to improve npm?Join in the discussion! »

    local-css

    1.1.1 • Public • Published

    local-css

    A browserify transform allowing you to require('styles.css') and get back locally scoped classnames.

    This is based on some ideas around css-modules, but not yet as fully-featured.

    Why local css?

    Normally you need to use a strict naming convention like BEM to ensure that one component's CSS doesn't collide with another's. Locally-scoped css 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 local-css

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

    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 local-css example/export-css.js | node > bundle.css

    Example

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

    Licence

    MIT

    Thanks and inspiration

    To all the fine folk working on css-modules

    Keywords

    none

    Install

    npm i local-css

    DownloadsWeekly Downloads

    5

    Version

    1.1.1

    License

    MIT

    Last publish

    Collaborators

    • avatar