Transforms styleName to className using compile time CSS module resolution.
In contrast to react-css-modules, babel-plugin-react-css-modules has a lot smaller performance overhead (0-10% vs +50%; see Performance) and a lot smaller size footprint (less than 2kb vs 17kb react-css-modules + lodash dependency).
CSS Modules are awesome! If you are not familiar with CSS Modules, it is a concept of using a module bundler such as webpack to load CSS scoped to a particular document. CSS module loader will generate a unique name for each CSS class at the time of loading the CSS document (Interoperable CSS to be precise). To see CSS Modules in practice, webpack-demo.
In the context of React, CSS Modules look like this:
import React from 'react';import styles from './table.css';export default class Table extends React.Component { render () { return <div className={styles.table}> <div className={styles.row}> <div className={styles.cell}>A0</div> <div className={styles.cell}>B0</div> </div> </div>; }}
Rendering the component will produce a markup similar to:
react-css-modules introduced a convention of using styleName attribute to reference CSS module. react-css-modules is a higher-order React component. It is using the styleName value to construct the className value at the run-time. This abstraction frees a developer from needing to reference the imported styles object when using CSS modules (What's the problem?). However, this approach has a measurable performance penalty (see Performance).
babel-plugin-react-css-modules solves the developer experience problem without impacting the performance.
Performance
The important metric here is the "Difference from the base benchmark". "base" is defined as using React with hardcoded className values. The lesser the difference, the bigger the performance impact.
Note:
This benchmark suite does not include a scenario when babel-plugin-react-css-modules can statically construct a literal value at the build time.
If a literal value of the className is constructed at the compile time, the performance is equal to the base benchmark.
Must match webpack context configuration. css-loader inherits context values from webpack. Other CSS module implementations might use different context resolution logic.
process.cwd()
exclude
string
A RegExp that will exclude otherwise included files e.g., to exclude all styles from node_modules exclude: 'node_modules'
filetypes
?FiletypesConfigurationType
Configure postcss syntax loaders like sugarss, LESS and SCSS and extra plugins for them.
generateScopedName
?GenerateScopedNameConfigurationType
Refer to Generating scoped names. If you use this option, make sure it matches the value of localIdentName in webpack config. See this issue
[path]___[name]__[local]___[hash:base64:5]
removeImport
boolean
Remove the matching style import. This option is used to enable server-side rendering.
false
webpackHotModuleReloading
boolean
Enables hot reloading of CSS in webpack
false
handleMissingStyleName
"throw", "warn", "ignore"
Determines what should be done for undefined CSS modules (using a styleName for which there is no CSS module defined). Setting this option to "ignore" is equivalent to setting errorWhenNotFound: false in react-css-modules.
You can set your own attribute mapping rules using the attributeNames option.
It's an object, where keys are source attribute names and values are destination attribute names.
For example, the <NavLink> component from React Router has a activeClassName attribute to accept an additional class name. You can set "attributeNames": { "activeStyleName": "activeClassName" } to transform it.
The default styleName -> className transformation will not be affected by an attributeNames value without a styleName key. Of course you can use { "styleName": "somethingOther" } to change it, or use { "styleName": null } to disable it.
Installation
When babel-plugin-react-css-modules cannot resolve CSS module at a compile time, it imports a helper function (read Runtime styleName resolution). Therefore, you must install babel-plugin-react-css-modules as a direct dependency of the project.
npm install babel-plugin-react-css-modules --save
React Native
If you'd like to get this working in React Native, you're going to have to allow custom import extensions, via a rn-cli.config.js file:
Remember, also, that the bundler caches things like plugins and presets. If you want to change your .babelrc (to add this plugin) then you'll want to add the --reset-cache flag to the end of the package command.
Anonymous reference can be used when there is only one stylesheet import.
Format: CSS module name.
Example:
import './foo1.css';// Imports "a" CSS module from ./foo1.css.<div styleName="a"></div>;
Named reference
Named reference is used to refer to a specific stylesheet import.
Format: [name of the import].[CSS module name].
Example:
import foo from './foo1.css';import bar from './bar1.css';// Imports "a" CSS module from ./foo1.css.<div styleName="foo.a"></div>;// Imports "a" CSS module from ./bar1.css.<div styleName="bar.a"></div>;
Example transpilations
Anonymous styleName resolution
When styleName is a literal string value, babel-plugin-react-css-modules resolves the value of className at the compile time.
When a file imports multiple stylesheets, you must use a named reference.
Have suggestions for an alternative behaviour?
Raise an issue with your suggestion.
Input:
import foo from './foo1.css';import bar from './bar1.css';<div styleName="foo.a"></div>;<div styleName="bar.a"></div>;
Output:
import foo from './foo1.css';import bar from './bar1.css';<div className="foo___a"></div>;<div className="bar___a"></div>;
Runtime styleName resolution
When the value of styleName cannot be determined at the compile time, babel-plugin-react-css-modules inlines all possible styles into the file. It then uses getClassName helper function to resolve the styleName value at the runtime.
This enables live reloading of the CSS. To enable HMR of the React components, refer to the Hot Module Replacement - React guide.
Note:
This is a webpack specific option. If you are using babel-plugin-react-css-modules in a different setup and require CSS live reloading, raise an issue describing your setup.