Skip to content

Latest commit

 

History

History

plugin-react-oxc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

@vitejs/plugin-react-oxc npm

The future default Vite plugin for React projects.

// vite.config.jsimport{defineConfig}from'vite'importreactfrom'@vitejs/plugin-react-oxc'exportdefaultdefineConfig({plugins: [react()],})

Caveats

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

Options

include/exclude

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

import{defineConfig}from'vite'importreactfrom'@vitejs/plugin-react'importmdxfrom'@mdx-js/rollup'exportdefaultdefineConfig({plugins: [{enforce: 'pre', ...mdx()},react({include: /\.(mdx|js|jsx|ts|tsx)$/}),],})

node_modules are never processed by this plugin (but Oxc will)

jsxImportSource

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

react({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:

app.get('/',async(req,res,next)=>{try{lethtml=fs.readFileSync(path.resolve(root,'index.html'),'utf-8')// Transform HTML using Vite plugins.html=awaitviteServer.transformIndexHtml(req.url,html)res.send(html)}catch(e){returnnext(e)}})

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.

close