@vitejs/plugin-react

@vitejs/plugin-react

The default Vite plugin for React projects.

• enable Fast Refresh in development (requires react >= 16.9)
• use the automatic JSX runtime
• small installation size

// vite.config.js
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [react()],
})

Options

include

Includes .js, .jsx, .ts & .tsx by default. This option can be used to add fast refresh to .mdx files:

import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import mdx from '@mdx-js/rollup'

export default defineConfig({
  plugins: [
    { enforce: 'pre', ...mdx() },
    react({ include: /\.(mdx|js|jsx|ts|tsx)$/ }),
  ],
})

exclude

The default value is /node_modules/. You may use it to exclude JSX/TSX files that runs in a worker or are not React files. Except if explicitly desired, you should keep node_modules in the exclude list:

import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [
    react({ exclude: [/\/pdf\//, /\.solid\.tsx$/, /\/node_modules\//] }),
  ],
})

jsxImportSource

Control where the JSX factory is imported from. By default, this is inferred from jsxImportSource from corresponding a tsconfig file for a transformed file.

react({ jsxImportSource: '@emotion/react' })

jsxRuntime

By default, the plugin uses the automatic JSX runtime. However, if you encounter any issues, you may opt out using the jsxRuntime option.

react({ jsxRuntime: 'classic' })

reactRefreshHost

The reactRefreshHost option is only necessary in a module federation context. It enables HMR to work between a remote & host application. In your remote Vite config, you would add your host origin:

react({ reactRefreshHost: 'http://localhost:3000' })

Under the hood, this simply updates the React Fash Refresh runtime URL from /@react-refresh to http://localhost:3000/@react-refresh to ensure there is only one Refresh runtime across the whole application. Note that if you define base option in the host application, you need to include it in the option, like: http://localhost:3000/{base}.

React Compiler

React Compiler support is available via the exported reactCompilerPreset helper, which requires @rolldown/plugin-babel and babel-plugin-react-compiler as peer dependencies:

npm install -D @rolldown/plugin-babel babel-plugin-react-compiler

// vite.config.js
import { defineConfig } from 'vite'
import react, { reactCompilerPreset } from '@vitejs/plugin-react'
import babel from '@rolldown/plugin-babel'

export default defineConfig({
  plugins: [react(), babel({ presets: [reactCompilerPreset()] })],
})

The reactCompilerPreset accepts an optional options object with the following properties:

• compilationMode — Set to 'annotation' to only compile components annotated with "use memo".
• target — Set to '17' or '18' to target older React versions (uses react-compiler-runtime instead of react/compiler-runtime).

babel({
  presets: [reactCompilerPreset({ compilationMode: 'annotation' })],
})

@vitejs/plugin-react/preamble

The package provides @vitejs/plugin-react/preamble to initialize HMR runtime from client entrypoint for SSR applications which don't use transformIndexHtml API. For example:

// [entry.client.js]
import '@vitejs/plugin-react/preamble'

Alternatively, you can manually call transformIndexHtml during SSR, which sets up equivalent initialization code. Here's an example for an Express server:

app.get('/', async (req, res, next) => {
  try {
    let html = fs.readFileSync(path.resolve(root, 'index.html'), 'utf-8')

    // Transform HTML using Vite plugins.
    html = await viteServer.transformIndexHtml(req.url, html)

    res.send(html)
  } catch (e) {
    return next(e)
  }
})

Otherwise, you'll get the following error:

Uncaught Error: @vitejs/plugin-react can't detect preamble. Something is wrong.

Consistent components exports

For React refresh to work correctly, your file should only export React components. You can find a good explanation in the Gatsby docs.

If an incompatible change in exports is found, the module will be invalidated and HMR will propagate. To make it easier to export simple constants alongside your component, the module is only invalidated when their value changes.

You can catch mistakes and get more detailed warning with this eslint rule.

Similar packages

Other packages similar to @vitejs/plugin-react

react-refresh-webpack-plugin

A Webpack plugin that enables React Fast Refresh. It is similar to @vitejs/plugin-react in providing hot reloading capabilities but is specific to Webpack-based projects.

babel-preset-react-app

This Babel preset includes the necessary Babel plugins for React applications created with Create React App. It handles JSX transformation and other React optimizations but does not provide hot reloading on its own.

craco

CRACO (Create React App Configuration Override) is an npm package that allows you to customize the Create React App configuration without ejecting. It can be used to modify Babel and Webpack configurations, similar to how @vitejs/plugin-react allows for custom configurations in a Vite project.