cssobj-plugin-localize

Localize class names for cssobj. Put CSS Class names into different name space.

Install

install from github directly:

npm install cssobj/cssobj-plugin-localize

API

localize(space: boolean|string, localNames: object) -> {selector: function}

space

• Type: String | Boolean

• Default: Random String

If pass empty string '', will use '' (empty space)

If pass other falsy value, will use default.

localNames

• Type: Object

• Default: {}

key/val pair to define how class name map into local name.

Key is original class name.

Val is localized name.

RETURN

Add method to result

The cssobj result object will be added 2 method by this plugin:

- result.mapSel({string} selector){ return {string} mappedSelector }

Replace class names in selector string, with all class names replace by localized version. (keep dot .)

- result.mapClass({string} classList){ return {string} mappedClassList }

Treat classList string as space seperated class list(e.g. in <div class="abc efg">),

Replace all seperated word by localized version. (without dot)

The classList can be 'nav item', or '.nav .item' form, all . will be replaced by space.

The returned class string is .trim()ed, you need polyfill this method if you want support IE < 9.

Above 2 method both can accept .!class1 .!class2 escaped for global space.

Usage

- Localize

var localize = require('cssobj-plugin-localize')
var ret = cssobj({'.item': {color: 'red'}}, {
  plugins:[  localize() ]
})
// css is => ._1hisnf23_item {color: red;}
 
// you can get the mapped selector using:
ret.mapSel('.nav .item')  // === ._1hisnf23_nav ._1hisnf23_item
 
// you can get the mapped class list using:
// (used in className attributes for HTML tag)
ret.mapClass('.nav .item')  // === _1hisnf23_nav _1hisnf23_item
ret.mapClass('nav item')  // === _1hisnf23_nav _1hisnf23_item
 

- Global

There's a way to make class Global

- .!className

Just add ! in front of class name, if you want it global.

var ret = cssobj({'body .!nav .!item .login': {color: 'red'}}, {
  plugins:[  localize() ]
})
// css is => body .nav .item ._1hisnf23_login {color: red;}

- Custom Prefix

You can control the space:

var ret = cssobj({'body .nav .item .login': {color: 'red'}}, {
  plugins:[  localize('_your_space_') ]
})
// css is => body ._your_space_nav ._your_space_item ._your_space_login {color: red;}

- Custom Local Names

You can control the map for each class name:

var ret = cssobj({'body .nav .!item .login': {color: 'red'}}, {
  plugins:[  localize(null, {nav: '_abc_'}) ]
})
// css is => body ._abc_ .!item ._1hisnf23_login {color: red;}

- Get the class map

var ret = cssobj({'body .nav .item .login': {color: 'red'}}, {
  plugins:[  localize('_space_', {nav: '_abc_'}) ]
})
 
ret.mapSel('.nav .item .!pushRight')  // === ._abc_ ._space_item .pushRight
ret.mapSel('.!nav .!item .pushRight')  // === .nav .item ._space_pushRight
ret.mapClass('item nav !pushRight')  // ===  _space_item _abc_ pushRight