Skip to content

Added some notes on porting #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 19, 2018
Merged

Added some notes on porting #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6468906
Added some notes on porting
Apr 19, 2018
59d4fef
docs: update wording
gajus Apr 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ In contrast to [`react-css-modules`](https://github.com/gajus/react-css-modules)
* [Limitations](#limitations)
* [Have a question or want to suggest an improvement?](#have-a-question-or-want-to-suggest-an-improvement)
* [FAQ](#faq)
* [How to migrate from react-css-modules to babel-plugin-react-css-modules?](#how-to-migrate-from-react-css-modules-to-babel-plugin-react-css-modules)
* [How to reference multiple CSS modules?](#how-to-reference-multiple-css-modules)
* [How to live reload the CSS?](#hot-to-live-reload-the-css)

Expand Down Expand Up @@ -446,6 +447,19 @@ const _styleModuleImportMap = {

## FAQ

### How to migrate from react-css-modules to babel-plugin-react-css-modules?

Follow the following steps:

* Remove `react-css-modules`.
* Add `babel-plugin-react-css-modules`.
* Configure `.babelrc` (see [Configuration](#configuration)).
* Remove all uses of the `cssModules` decorator and/or HoC.

If you are still having problems, refer to one of the user submitted guides:

* [Porting from react-css-modules to babel-plugin-react-css-modules (with Less)](http://www.jjinux.com/2018/04/javascript-porting-from-react-css.html)

### How to reference multiple CSS modules?

`react-css-modules` had an option [`allowMultiple`](https://github.com/gajus/react-css-modules#allowmultiple). `allowMultiple` allows multiple CSS module names in a `styleName` declaration, e.g.
Expand All @@ -456,7 +470,7 @@ const _styleModuleImportMap = {

This behaviour is enabled by default in `babel-plugin-react-css-modules`.

## How to live reload the CSS?
### How to live reload the CSS?

`babel-plugin-react-css-modules` utilises webpack [Hot Module Replacement](https://webpack.github.io/docs/hot-module-replacement.html) (HMR) to live reload the CSS.

Expand Down