Skip to content

Commit 656b49f

Browse files
authored
docs: add note for conversion from react hot loader (#198)
1 parent 82cd46e commit 656b49f

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/TROUBLESHOOTING.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Troubleshooting
22

3+
## Coming from `react-hot-loader`
4+
5+
If you are coming from `react-hot-loader`, before using the plugin,
6+
you have to ensure that you've completely erased the integration of RHL from your app:
7+
8+
- Removed the `react-hot-loader/babel` Babel plugin (from Babel config variants or Webpack config)
9+
- Removed the `react-hot-loader/patch` Webpack entry
10+
- Removed the `react-hot-loader/webpack` Webpack loader
11+
- Removed the alias of `react-dom` to `@hot-loader/react-dom` (from `package.json` or Webpack config)
12+
- Removed imports and their usages from `react-hot-loader`
13+
14+
This has to be done because, internally,
15+
`react-hot-loader` intercepts and reconciles the React tree before React can try to re-render it.
16+
That in turn breaks mechanisms the plugin depends on to deliver the experience.
17+
318
## Compatibility with IE11 (`webpack-dev-server` only)
419

520
If you need to develop on IE11, you will need to polyfill the DOM URL API.
@@ -25,7 +40,7 @@ import 'react-app-polyfill/ie11';
2540
import 'react-app-polyfill/stable';
2641
```
2742

28-
Note that this also polyfills other APIs that are not available on IE11 (potentially expensive).
43+
Note that `react-app-polyfill` also polyfills other APIs that are not available on IE11 (potentially expensive).
2944

3045
## Usage with Indirection (like Workers and JS Templates)
3146

0 commit comments

Comments
 (0)