JSS plugin, allows classes composition.
Clone or download
Latest commit c5052cb Sep 30, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src jss 8 Jun 20, 2017
.babelrc refactoring Sep 27, 2016
.eslintrc JSS compose first version Sep 17, 2016
.gitignore tests integration, release 1.1.0 Sep 30, 2016
.npmignore tests integration, release 1.1.0 Sep 30, 2016
LICENSE JSS compose first version Sep 17, 2016
changelog.md support JSS 9 Sep 30, 2017
karma.conf.js remove lodash-assign from deps Sep 30, 2016
package-lock.json 5.0.0 Sep 30, 2017
package.json 5.0.0 Sep 30, 2017
readme.md changelog, docs for 2.1.0 Mar 21, 2017
tests.html tests integration, release 1.1.0 Sep 30, 2016
tests.webpack.js refactoring Sep 27, 2016
webpack.config.js tests integration, release 1.1.0 Sep 30, 2016

readme.md

JSS plugin for classes composition

This plugin allows you to use CSS frameworks and legacy code together with JSS as well as reuse Rules more granularly.

Make sure you read how to use plugins in general.

Gitter

Compose with global classes.

To combine JSS with CSS framework like Material Design Lite or Bootstrap and others.

const styles = {
  button: {
    // Using space separated class names.
    composes: 'btn btn-primary',
    color: 'red'
  }
  buttonActive: {
    // Using an array of class names.
    composes: ['btn', 'btn-primary'],
    color: 'blue'
  }
}

Compiles to:

.button-123456 {
  color: red;
}
.buttonActive-123456 {
  color: blue;
}

When you use it:

<button className={classes.button}>Button</button>
<button className={classes.buttonActive}>Active Button</button>

It renders to:

<button class="button-123456 btn">Button</button>
<button class="button-123456 btn btn-primary">Active Button</button>

Compose with local classes.

Manage element states without rules duplication. To reference a local rule, prefix the rule name with $ symbol.

const styles = {
  button: {
    color: 'black'
  },

  // You can chain compositions
  buttonActive: {
    composes: '$button',
    color: 'red'
  },
  buttonActiveDisabled: {
    composes: '$buttonActive',
    opacity: 0.5
  },

  // Or use arrays
  disabled: {
    opacity: 0.5
  },
  active: {
    color: 'red'
  },
  buttonDisabled: {
    composes: ['$button', '$active', '$disabled']
  }
}

Compiles to:

.button-123456 {
  color: black;
}
.buttonActive-123456 {
  color: red;
}
.buttonActiveDisabled-123456 {
  opacity: 0.5;
}
.disabled-123456 {
  opacity: 0.5;
}
.active-123456 {
  color: red;
}
/* Rule `buttonDisabled` is not compiled to CSS, because it has no own properties. */

When you use it:

<button className={classes.buttonActiveDisabled}>Active Disabled Button</button>
<button className={classes.buttonDisabled}>Disabled Button with active state</button>

It renders to:

<button class="button-123456 buttonActive-123456">Active Disabled Button</button>
<button class="buttonDisabled-123456 button-123456 active-123456 disabled-123456">Disabled Button with active state</button>

Mix global and local classes.

You can compose both local and global classes at the same time.

const styles = {
  active: {
    color: 'red'
  },
  button: {
    composes: ['$active', 'btn', 'btn-primary'],
    color: 'blue'
  }
}

Compiles to:

.active-123456 {
  color: red;
}
.button-123456 {
  color: blue;
}

When you use it:

<button className={classes.button}>Button</button>

It renders to:

<button class="button-123456 active-123456 btn btn-primary">Button</button>

Caveats

  • Doesn't work within global Style Sheets.
  • Does not work inside of nested rules.
  • When composing local rules, they need to be defined first. Otherwise you get wrong css selector order and specificity.

Issues

File a bug against cssinjs/jss prefixed with [jss-compose].

Run tests

npm i
npm test

License

MIT