Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.97 KB

README.md

File metadata and controls

62 lines (41 loc) · 2.97 KB
Raw

WIP: Stylishly

Build Status Coverage Status npm

Stylishly is a WIP. At your own peril.

Stylishly is a JavaScript library designed for controlling CSS styling in a component based framework.

Features

  • CSS in JS
  • Theming
  • Real stylesheets
  • Deterministic className resolution
  • Webpack HMR compatibile
  • Server side rendering
  • Plugin system and custom renderers (allows you to customize pretty much anything)
  • @media queries and @keyframes (optional plugin)
  • descendant and chained selectors via nesting (optional plugin(s))
  • :pseudo selectors (optional plugin)
  • Autoprefixing (optional plugin)

Design & Justification

Over at callemall/material-ui we've struggled to make inline-only styles work smoothly both internally and for our users due to various drawbacks ranging from difficulty overriding styles to the requirement to add significant boilerplate code in order to implement basic CSS functionality such as :hover in JS.

Stylishly allows you to use JavaScript to create real stylesheets in a fashion that meshes well with a component based design. This enables use of the usual suspects (media queries, pseudo selectors, etc...), which are impossible with an inline-only solution.

Another important requirement for stylishly was enabling use of a theme object for style creation. Themes and customization are a central part of the developer experience with material-ui and this library has been designed from the ground up with theming as a core feature.

Stylishly is not designed to handle dynamic property changes in style resolution. Rules are intended to be static once created, favouring traditional CSS design patterns such as switching class names. Truly dynamic properties still belong inline. This design decision combined with deterministic selector resolution allows stylishly to be implemented in a library and provide an interface that works for all users, whether they enjoy using JS styles themselves or are consuming the library in an application that uses a more traditional styling solution. This was a key consideration when developing a solution that would work for material-ui.

Installation

npm install stylishly --save

Super Basic Example

import {createStyleManager} from 'stylishly/lib/styleManager';
import {createStyleSheet} from 'stylishly/lib/styleSheet';

const styleManager = createStyleManager();

const styleSheet = createStyleSheet('woof', () => ({
  meow: {
    color: 'red'
  }
}));

const classes = styleManager.render(styleSheet);

Documentation