readme.md

Nicobar

Javascript package for theming layouts.

Install

Make sure you have node and npm installed.

$ npm install nicobar

Using

Vanilla JS

Create or update your code as normal using your CSS, but if something has to change, use CSS Custom properties to set a variable.

Like this

.some-class {
   display: inline-block;
   background: var(--background, #f00);  
}

then in JS your code.

nicobar.set('.some-class', { background: '#0f0' });

you can use it how many times you want.

nicobar.set(target, data) the set method accept String or HTMLElement (for while). and the data is a Object with key as custom-property name.

React

Inject nicobar in your project

import { Nicobar } from 'nicobar'
// or
const Nicobar = require('nicobar').Nicobar;

then init on your component Wrapper Constructor

class MyComponent extends React.Component {
  render() {
    return <Nicobar style={obj}>
      ...
    </Nicobar>
  }
}

Inject nicobar in your project

import { component } from 'nicobar'
// or
const component = require('nicobar').component;

using Component Builder

const MyElement = component('className', { styleObj }, MyOtherElement)
// or
const MyElement = component.div('className', { styleObj }) // <- You can use any dom element.

class MyComponent extends React.Component {
  render() {
    return <div>
      <MyElement/>
    </div>
  }
}

when it is done you can only change the property style and everything will run as expected.

Contributing

1. Fork
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Submit a pull request

Feature branch (git checkout -b my-new-feature) | commit (git commit -m 'Add some feature') | push (git push origin my-new-feature).

License

MIT License