cssobj-mithril v2.1.0

cssobj-mithril

Apply cssobj local class names into mithril.

SEE DEMO

Why?

cssobj already have API for using with mithril as below:

var result = cssobj(obj)
... ...
view: function(){
  return m( result.mapSel('li.item'), {class: result.mapClass('active news')} )
}

But if you don't like the long result.mapSel, result.mapClass function, you can try this lib to simplify.

This lib is just syntax sugar for the above code.

To do this, we have to replace the m function with new m, see below.

Install

NPM

npm install cssobj-mithril

BOWER

bower install cssobj-mithril

Usage

Used with cssobj as below:

// init mithril
var mithril = require('mithril')

// get a factory function from old mithril
var M = require('cssobj-mithril')(mithril)

// get cssobj result
var result = require('cssobj')(obj)

// **** replace m!! ****
var m = M(result)

// consume `m` as original way, don't change anything!
// except `selector` and `class` will accept `:global` and `!`
var component = {
  view: function(){

    return m('li.item', {class:'news !active'}, 'hello')

    // rendered DOM result:
    // <li class="_4vsdei1_item _4vsdei1_news active">hello</li>

  }
}

Use m in all cases as usual, with the benefit fo local class names.

Please see test/ folder for more info.

API

STEP ONE

CommonJS: var mFactory = require('cssobj-mithril')( M? )

Global: var mFactory = cssobj_mithril( M? )

M (optional)

Which mithril m function to inject, can be omitted if m already in global space.

mFactory.m can be used as original mithril m function.

RETURN

mFactory can be used to produce different m with each bound to an cssobj result instance.

STEP TWO

var m = mFactory( cssobjResult )

cssobjResult

cssobj() result Object instance, with local=true, or local=false.

RETURN

m

mithril m pre processor Function(m), will lookup the cssobj result object for local class names.

• m: Function The signature is same as m
• m.result: Object Just a shortcut reference to result param passed in. mc.result === result
• m.old: Function The old mithril m reference

Usage

The below 2 codes are equivalent:

const M = require('mithril')
const m = require('cssobj-mithril')( M )( result )
...
view: function(){
  return m('li.item', {class:'active news'})
}

// m.old === M
view: function(){
  return m.old( result.mapSel('li.item'), {class: result.mapClass('active news')} )
}

See, it's simplify the usage for cssobj with mithril.