Search
Docs Menu
API
Get Started
Blog
Edit

vike-react

Version history: CHANGELOG.md
Examples: vike.dev/new and examples/
Source code: GitHub > vikejs/vike-react

The Vike extension vike-react integrates React in a full-fledged manner, providing a DX like a regular frontend framework like Next.js and Remix.

The documentation for using vike-react can be found throughout this website (vike.dev).

The guides, such as Guides > Data Fetching, assume you're using Vike with vike-react, vike-vue, or vike-solid. If you aren't then see the sections Without vike-{react,vue,solid} such as API > useData() > Without vike-{react,vue,solid}.

You can integrate React yourself instead of using vike-react, see React > Custom integration.

Notes about RSC:

Scaffold new vike-react app

Use vike.dev/new for creating a new vike-react app.

Add vike-react to existing Vike app

To add vike-react to an existing Vike app: install the vike-react npm package (e.g. $ npm install vike-react) then extend your existing +config.js file (or create one) with vike-react:

// /pages/+config.js
 
import vikeReact from 'vike-react/config'
 
export default {
  // ...
  extends: [vikeReact] 
}
// /pages/+config.ts
 
import type { Config } from 'vike/types'
import vikeReact from 'vike-react/config'
 
export default {
  // ...
  extends: [vikeReact]
} satisfies Config

You can then use new settings introduced by vike-react:

// /pages/+config.js
 
import vikeReact from 'vike-react/config'
 
export default {
  // ...
 
  // Setting to toggle SSR
  ssr: false, 
 
  extends: [vikeReact]
}
// /pages/+config.ts
 
import type { Config } from 'vike/types'
import vikeReact from 'vike-react/config'
 
export default {
  // ...
 
  // Setting to toggle SSR
  ssr: false,
 
  extends: [vikeReact]
} satisfies Config

See also:

Under the hood

The vike-react extension is only around 1k lines of code. It's simple, readable, and highly polished.

Reading the source code of vike-react is very much an option for understanding, debugging, and/or contributing.

Contributions are welcome! See CONTRIBUTING.md to get started.

What vike-react does is essentially this:

It implements the following:

For a better overview, see the following lists instead. (They also include all settings and hooks created by vike-react.)

See also