@nmarks/jss

v5.4.6

Published

2 years ago

A lib for generating Style Sheets with JavaScript.

Downloads

0High
0Medium
0Low

nmarks

jss style sheet stylesheet css components composable

JSS

![Gitter](https://badges.gitter.im/Join Chat.svg)

JSS is a better abstraction over CSS. It uses JavaScript as a language to describe styles in a declarative and maintainable way. It compiles to CSS at runtime or server-side and is potentially more performant. You can use it with React or with any other library. It is less than 4KB (minfied and gzipped) and is extensible via plugins API.

Example

You think writing CSS in JS is ugly? Try CSSX, it compiles to JSS JSON and allows you to write in CSSX language, but render with JSS.

You need to setup plugins before. You can use a preset for a quick setup with default plugins.

import jss from 'jss'
import preset from 'jss-preset-default'
import color from 'color'

// One time setup with default plugins and settings.
jss.setup(preset())

const styles = {
  button: {
    fontSize: 12,
    '&:hover': {
      background: 'blue'
    }
  },
  ctaButton: {
    extend: 'button',
    '&:hover': {
      background: color('blue').darken(0.3).hexString()
    }
  },
  '@media (min-width: 1024px)': {
    button: {
      width: 200
    }
  }
}

const {classes} = jss.createStyleSheet(styles).attach()

document.body.innerHTML = `
  <button class="${classes.button}">Button</button>
  <button class="${classes.ctaButton}">CTA Button</button>
`

Result

<head>
  <style type="text/css">
    .button-123456 {
      font-size: 12px;
    }
    .button-123456:hover {
      background: blue;
    }
    .ctaButton-789012 {
      font-size: 12px;
    }
    .ctaButton-789012:hover {
      background: red;
    }
    @media (min-width: 1024px) {
      .button-123456 {
        min-width: 200px;
      }
    }
  </style>
</head>
<body>
  <button class="button-123456">Button</button>
  <button class="ctaButton-789012">CTA Button</button>
</body>

When should I use it?

You build a JavaScript heavy application.
You use components based architecture.
You build a reusable UI library.
You need a collision free CSS (external content, third-party UI components ...).
You need code sharing between js and css.
Minimal download size is important to you.
Robustness and code reuse is important to you.
Ease of maintenance is important to you.
You just want to use any of its benefits

Roadmap

~~Make it easier for newcomers to setup jss with plugins (like presets).~~
Make community create plugins (better plugins API documentation, infrastructure).
Make it easy to see when changes in the core break plugins (integrate plugins test suite).
Do more benchmarking, include plugins, always track perf regressions.
Make JSON DSL even better, for e.g. jss-expand.
Introduce a way for theming with react-jss.
Make SSR even better (vendor prefixer, smaller critical CSS)
Make CLI tool better, allow integration of styles written in various preprocessing languages as well as pure css.
React Native support.

Browsers Support

We have automated tests running in real browsers.

License

MIT

Thanks

Thanks to BrowserStack for providing the infrastructure that allows us to run our build in real browsers and to all awesome contributors.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

JSS