/jss-expand

JSS plugin that gives you a better syntax than CSS.

Primary LanguageJavaScriptMIT LicenseMIT

JSS logo

JSS plugin that gives you a better syntax than CSS.

Can you remember what each of those values mean box-shadow: 2px 2px 2px 1px gold; and in which order they have to be used? Me neither. CSS values are sometimes cryptic. This plugin makes them easy to read and to remember.

Make sure you read how to use plugins in general.

Usage example

const sheet = jss.createStyleSheet({
  container: {
    padding: [20, 10],
    background: {
        color: '#000',
        image: 'url(image.jpg)',
        position: [0, 0],
        repeat: 'no-repeat'
    },
    transition: [
      {
        property: 'opacity',
        duration: '200ms'
      }, 
      {
        property: 'width',
        duration: '300ms'
      }
    ]
  }
})
.jss-0-0 {
  padding: 20px 10px;
  background: #000 url(image.jpg) 0 0 no-repeat;
  transition: opacity 200ms, width 300ms;
}

Features

  1. One syntax for arrays. This plugin simplifies writing values as array of numbers for margin, padding, border-radius, background-position, transform, transition, animation, box-shadow, text-shadow:
padding: [20, 10],
border-radius: ['50%', '10%'],
transition: [['opacity', '200ms'], ['width', '300ms']]

instead of comma and space separated syntax from jss:

padding: [[20, 10]],
border-radius: [['50%', '10%']],
transition: [[['opacity', '200ms']], [['width', '300ms']]]
  1. Writing values as object for padding, margin, background, border, border-top, border-bottom, border-left, border-right, outline, list-style, transition, animation, box-shadow, text-shadow, flex
border: {
  width: '1px',
  style: 'solid',
  color: '#f00'
}

will be converted to

border: 1px solid #f00;
  1. Writing values as array of objects
transition: [{
    property: 'opacity',
    duration: '200ms'
  }, {
    property: 'width',
    duration: '300ms'
  }
]

will be converted to

transition: opacity 200ms, width 300ms;

More expanded documentation is available here

Order does matter

This plugin MUST BE used AFTER jss-camel-case and jss-extend and jss-default-unit and jss-nested

Known issues

This plugin doesn't support font property written in expanded way. This is because plugin must have maximum performance, and all exceptions like in font way of writing (joining of font-size and line-height joining with \ symbol) is forbidden.

Issues

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

Run tests

npm i
npm run test

Run benchmark tests

npm i
npm run bench

Licence

MIT