Skip to content

web-dev-lib/react-css-modules

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React CSS Modules

Travis build status NPM version

Usage

First you need to setup webpack to load your css files using "css" loader and enable CSS modules. You will also need to use extract-text-webpack-plugin to aggregate the CSS into a single file. Refer to webpack-demo.

Then you need use the higher order component declaration pattern to "decorate" your component, e.g.

import React from 'react';
import styles from './car.css';
import CSSModules from 'react-css-modules';

class Car extends React.Component {
    render () {
        return <div className='car'>
            <div className='front-door'></div>
            <div className='back-door'></div>
        </div>;
    }
}

export default CSSModules(Car, styles);

Thats it!

CSSModules extends Car render method. It will look for CSS classes in ./car.css that match ReactElement className and will append the matching unique class names to className declaration.

Refer to the react-css-modules-examples repository for a complete usage example.

Multiple CSS Classes

CSS modules promote composition pattern, i.e. every CSS class should define all properties required to describe the element, e.g.

.button {

}

.active {
    composes: common;

    /* anything that only applies to active state of the button */
}

.disabled {
    composes: common;

    /* anything that only applies to disabled state of the button */
}

To learn more about composing CSS rules, I suggest reading Glen Maddern article about CSS Modules and the official CSS modules spec.

However, using React CSS Modules, you can map as many CSS classes to the element as you want. CSSModules will append the unique class name for every class name it matches in the className declaration, e.g.

.button {

}

.active {

}
<div className='button active'></div>

This will work as you'd expect.

Options

|Name|Type|Description|Default| |---|---|---| |allowMultiple|Boolean|Determines weather className can have multiple class names.|true| |includeOriginal|Boolean|Determines weather the original className value should be kept in addition to the appended generated value.|true|

About

Seamless mapping of class names to CSS modules inside of React components.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%