[!IMPORTANT] This package is deprecated. Please use @vitejs/plugin-react instead, which automatically enables Oxc-based Fast Refresh transform on rolldown-vite.

@vitejs/plugin-react-oxc

The future default Vite plugin for React projects.

• enable Fast Refresh in development
• use the automatic JSX runtime
• small installation size

1// vite.config.js
2import { defineConfig } from 'vite'
3import react from '@vitejs/plugin-react-oxc'
4
5export default defineConfig({
6  plugins: [react()],
7})

Caveats

• jsx runtime is always automatic
• this plugin only works with rolldown-vite

Options

include/exclude

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

1import { defineConfig } from 'vite'
2import react from '@vitejs/plugin-react'
3import mdx from '@mdx-js/rollup'
4
5export default defineConfig({
6  plugins: [
7    { enforce: 'pre', ...mdx() },
8    react({ include: /\.(mdx|js|jsx|ts|tsx)$/ }),
9  ],
10})

jsxImportSource

Control where the JSX factory is imported from. Default to 'react'

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

Middleware mode

In middleware mode, you should make sure your entry index.html file is transformed by Vite. Here's an example for an Express server:

1app.get('/', async (req, res, next) => {
2  try {
3    let html = fs.readFileSync(path.resolve(root, 'index.html'), 'utf-8')
4
5    // Transform HTML using Vite plugins.
6    html = await viteServer.transformIndexHtml(req.url, html)
7
8    res.send(html)
9  } catch (e) {
10    return next(e)
11  }
12})

Otherwise, you'll probably get this error:

Uncaught Error: @vitejs/plugin-react-oxc 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.