# @umijs/react-refresh-webpack-plugin > An **EXPERIMENTAL** Webpack plugin to enable "Fast Refresh" (also previously known as _Hot Reloading_) for React components. Latest version **0.5.11** (published 2023-09-08) · MIT license · 0 weekly downloads ## Install ```sh npm install @umijs/react-refresh-webpack-plugin pnpm add @umijs/react-refresh-webpack-plugin yarn add @umijs/react-refresh-webpack-plugin bun add @umijs/react-refresh-webpack-plugin ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.5.11 | | Published | 2023-09-08 | | First published | 2023-09-08 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >= 10.13 | | Dependencies | 9 | | Unpacked size | 127.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Michael Mok | | Maintainers | xierenyuan, stormslowly, xiefengnian, sorrycc, chenshuai2144, kuitos, peachscript, xiaohuoni | | Keywords | react, javascript, webpack, refresh, hmr, hotreload, livereload, live, edit, hot, reload | ## Links - npm: https://www.npmjs.com/package/@umijs/react-refresh-webpack-plugin - Repository: https://github.com/pmmmwh/react-refresh-webpack-plugin - Homepage: https://github.com/pmmmwh/react-refresh-webpack-plugin#readme - Issues: https://github.com/pmmmwh/react-refresh-webpack-plugin/issues - npm.io page: https://npm.io/package/@umijs/react-refresh-webpack-plugin ## Dependencies (9) - [find-up](https://npm.io/package/find-up.md) ^5.0.0 - [source-map](https://npm.io/package/source-map.md) ^0.7.3 - [core-js-pure](https://npm.io/package/core-js-pure.md) ^3.23.3 - [loader-utils](https://npm.io/package/loader-utils.md) ^2.0.4 - [schema-utils](https://npm.io/package/schema-utils.md) ^3.0.0 - [html-entities](https://npm.io/package/html-entities.md) ^2.1.0 - [common-path-prefix](https://npm.io/package/common-path-prefix.md) ^3.0.0 - [error-stack-parser](https://npm.io/package/error-stack-parser.md) ^2.0.6 - [ansi-html-community](https://npm.io/package/ansi-html-community.md) ^0.0.8 ## Alternatives - [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads - [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads - [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads - [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads - [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads ## Recent versions - 0.5.11 (latest) — 2023-09-08 ## README # React Refresh Webpack Plugin [circleci]: https://app.circleci.com/pipelines/github/pmmmwh/react-refresh-webpack-plugin [circleci:badge]: https://img.shields.io/circleci/project/github/pmmmwh/react-refresh-webpack-plugin/main [license:badge]: https://img.shields.io/github/license/pmmmwh/react-refresh-webpack-plugin [npm:latest]: https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin/v/latest [npm:latest:badge]: https://img.shields.io/npm/v/@pmmmwh/react-refresh-webpack-plugin/latest [npm:next]: https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin/v/next [npm:next:badge]: https://img.shields.io/npm/v/@pmmmwh/react-refresh-webpack-plugin/next [![CircleCI][circleci:badge]][circleci] [![License][license:badge]](./LICENSE) [![Latest Version][npm:latest:badge]][npm:latest] [![Next Version][npm:next:badge]][npm:next] An **EXPERIMENTAL** Webpack plugin to enable "Fast Refresh" (also known as _Hot Reloading_) for React components. > This plugin is not 100% stable. > We're hoping to land a v1 release soon - please help us by reporting any issues you've encountered! ## Getting Started ### Prerequisites Ensure that you are using at least the minimum supported versions of this plugin's peer dependencies - older versions unfortunately do not contain code to orchestrate "Fast Refresh", and thus cannot be made compatible. We recommend using the following versions: | Dependency | Version | | --------------- | ---------------------------- | | `react` | `16.13.0`+, `17.x` or `18.x` | | `react-dom` | `16.13.0`+, `17.x` or `18.x` | | `react-refresh` | `0.10.0`+ | | `webpack` | `4.46.0`+ or `5.2.0`+ |
Minimum requirements
| Dependency | Version | | --------------- | -------- | | `react` | `16.9.0` | | `react-dom` | `16.9.0` | | `react-refresh` | `0.10.0` | | `webpack` | `4.43.0` |
Using custom renderers (e.g. react-three-fiber, react-pdf, ink)
To ensure full support of "Fast Refresh" with components rendered by custom renderers, you should ensure the renderer you're using depends on a recent version of `react-reconciler`. We recommend version `0.25.0` or above, but any versions above `0.22.0` should work. If the renderer is not compatible, please file them an issue instead.
### Installation With all prerequisites met, you can install this plugin using your package manager of choice: ```sh # if you prefer npm npm install -D @pmmmwh/react-refresh-webpack-plugin react-refresh # if you prefer yarn yarn add -D @pmmmwh/react-refresh-webpack-plugin react-refresh # if you prefer pnpm pnpm add -D @pmmmwh/react-refresh-webpack-plugin react-refresh ``` The `react-refresh` package (from the React team) is a required peer dependency of this plugin. We recommend using version `0.10.0` or above.
Support for TypeScript
TypeScript support is available out-of-the-box for those who use `webpack.config.ts`. Our exported types however depends on `type-fest`, so you'll have to add it as a `devDependency`: ```sh # if you prefer npm npm install -D type-fest # if you prefer yarn yarn add -D type-fest # if you prefer pnpm pnpm add -D type-fest ``` > **:memo: Note**: > > `type-fest@2.x` only supports Node.js v12.20 or above. > If you're using an older version of Node.js, please install `type-fest@1.x`.
### Usage For most setups, we recommend integrating with `babel-loader`. It covers the most use cases and is officially supported by the React team. The example below will assume you're using `webpack-dev-server`. If you haven't done so, set up your development Webpack configuration for Hot Module Replacement (HMR). ```js const isDevelopment = process.env.NODE_ENV !== 'production'; module.exports = { mode: isDevelopment ? 'development' : 'production', devServer: { hot: true, }, }; ```
Using webpack-hot-middleware
```js const webpack = require('webpack'); const isDevelopment = process.env.NODE_ENV !== 'production'; module.exports = { mode: isDevelopment ? 'development' : 'production', plugins: [isDevelopment && new webpack.HotModuleReplacementPlugin()].filter(Boolean), }; ```
Using webpack-plugin-serve
```js const { WebpackPluginServe } = require('webpack-plugin-serve'); const isDevelopment = process.env.NODE_ENV !== 'production'; module.exports = { mode: isDevelopment ? 'development' : 'production', plugins: [isDevelopment && new WebpackPluginServe()].filter(Boolean), }; ```
Then, add the `react-refresh/babel` plugin to your Babel configuration and this plugin to your Webpack configuration. ```js const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin'); const isDevelopment = process.env.NODE_ENV !== 'production'; module.exports = { mode: isDevelopment ? 'development' : 'production', module: { rules: [ { test: /\.[jt]sx?$/, exclude: /node_modules/, use: [ { loader: require.resolve('babel-loader'), options: { plugins: [isDevelopment && require.resolve('react-refresh/babel')].filter(Boolean), }, }, ], }, ], }, plugins: [isDevelopment && new ReactRefreshWebpackPlugin()].filter(Boolean), }; ``` > **:memo: Note**: > > Ensure both the Babel transform (`react-refresh/babel`) and this plugin are enabled only in `development` mode!
Using ts-loader
> **:warning: Warning**: > This is an un-official integration maintained by the community. Install [`react-refresh-typescript`](https://github.com/Jack-Works/react-refresh-transformer/tree/main/typescript). Ensure your TypeScript version is at least 4.0. ```sh # if you prefer npm npm install -D react-refresh-typescript # if you prefer yarn yarn add -D react-refresh-typescript # if you prefer pnpm pnpm add -D react-refresh-typescript ``` Then, instead of wiring up `react-refresh/babel` via `babel-loader`, you can wire-up `react-refresh-typescript` with `ts-loader`: ```js const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin'); const ReactRefreshTypeScript = require('react-refresh-typescript'); const isDevelopment = process.env.NODE_ENV !== 'production'; module.exports = { mode: isDevelopment ? 'development' : 'production', module: { rules: [ { test: /\.[jt]sx?$/, exclude: /node_modules/, use: [ { loader: require.resolve('ts-loader'), options: { getCustomTransformers: () => ({ before: [isDevelopment && ReactRefreshTypeScript()].filter(Boolean), }), transpileOnly: isDevelopment, }, }, ], }, ], }, plugins: [isDevelopment && new ReactRefreshWebpackPlugin()].filter(Boolean), }; ``` > `ts-loader` won't work with HMR unless `transpileOnly` is set to `true`. > You should use `ForkTsCheckerWebpackPlugin` if you need typechecking during development.
Using swc-loader
> **:warning: Warning**: > This is an un-official integration maintained by the community. Ensure your `@swc/core` version is at least `1.2.86`. It is also recommended to use `swc-loader` version `0.1.13` or above. Then, instead of wiring up `react-refresh/babel` via `babel-loader`, you can wire-up `swc-loader` and use the `refresh` transform: ```js const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin'); const isDevelopment = process.env.NODE_ENV !== 'production'; module.exports = { mode: isDevelopment ? 'development' : 'production', module: { rules: [ { test: /\.[jt]sx?$/, exclude: /node_modules/, use: [ { loader: require.resolve('swc-loader'), options: { jsc: { transform: { react: { development: isDevelopment, refresh: isDevelopment, }, }, }, }, }, ], }, ], }, plugins: [isDevelopment && new ReactRefreshWebpackPlugin()].filter(Boolean), }; ``` > Starting from version `0.1.13`, `swc-loader` will set the `development` option based on Webpack's `mode` option. > `swc` won't enable fast refresh when `development` is `false`.
For more information on how to set up "Fast Refresh" with different integrations, please check out [our examples](examples). ### Overlay Integration This plugin integrates with the most common Webpack HMR solutions to surface errors during development - in the form of an error overlay. By default, `webpack-dev-server` is used, but you can set the [`overlay.sockIntegration`](docs/API.md#sockintegration) option to match what you're using. The supported versions are as follows: | Dependency | Version | | ------------------------ | ----------------- | | `webpack-dev-server` | `3.6.0`+ or `4.x` | | `webpack-hot-middleware` | `2.x` | | `webpack-plugin-serve` | `0.x` or `1.x` | ## API Please refer to [the API docs](docs/API.md) for all available options. ## FAQs and Troubleshooting Please refer to [the Troubleshooting guide](docs/TROUBLESHOOTING.md) for FAQs and resolutions to common issues. ## License This project is licensed under the terms of the [MIT License](/LICENSE). ## Special Thanks JetBrains Logo --- _Source: https://npm.io/package/@umijs/react-refresh-webpack-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._