react-with-styles-interface-css

Interface for react-with-styles that compiles CSS-in-js styles to static CSS classes with deterministic and human-friendly class names whose styles can be easily overridden.

Usage

Interface

A react-with-styles interface which is to be used along with react-with-styles.

import ThemedStyleSheet from 'react-with-styles/lib/ThemedStyleSheet';
import CSSInterface, { registerCSSInterfaceNamespace } from 'react-with-styles-interface-css';

ThemedStyleSheet.registerInterface(CSSInterface);

// Optional: Prefix all class names in the output with 'MyPackageName__'
const namespace = 'MyPackageName';
registerCSSInterfaceNamespace(namespace);

Styles

When writing styles, all classes throughout a project should be given unique names. Otherwise, class name collisions may result in unexpected and unwanted behavior.

Overriding styles

The styles for a class can be overridden using the same name with which the class was defined. If the optional class name prefix was configured, the prefix should be used when overriding a class.

Note: In order to provide compatibility with aphrodite, the CSS output by this interface uses specifiers with varying levels of specificity. This allows for style resolution to be sensitive to the ordering of styles in calls to css(...). However, these extra specifiers should not be overridden.

Compile

The styles passed to withStyles in the source code are compiled to static CSS by the compileCSS function shown below. For convenience, a CLI wrapping compileCSS is provided.

Compile via CLI

Compile styles to CSS using the compile-css CLI.

• Expects a relative or absolute path to the entry point source file of a React application
• Automatically compiles the source file and its imported dependencies on the fly using the babel configuration present in the project if one exists
• Outputs a stylesheet.css file containing the compiled CSS in the current working directory

Run the CLI via npm script (preferred):

{
  "scripts": {
    "build:css": "compile-css src/App.jsx"
  }
}

npm run build:css

Run the CLI directly:

./node_modules/.bin/compile-css src/App.jsx

Compile via library function

import compileCSS from 'react-with-styles-interface-css/compile';

const entryPointFilePath = 'src/App.jsx';
// CSS is the minified CSS output
const CSS = compileCSS(entryPointFilePath);