@storyblok/react

The React plugin you need to interact with Storyblok API and enable the Real-time Visual Editing Experience. This package helps you integrate Storyblok with React along with all types of React based frameworks like Next.js, Remix etc. This SDK includes support for React Server Components, static site generation, and Next.js static exports.

Kickstart a new project

Are you eager to dive into coding? Follow these steps to kickstart a new project with Storyblok and React, and get started in just a few minutes!

5-minute Tutorial

Are you looking for a hands-on, step-by-step tutorial? The React 5-minute Tutorial has you covered! It provides comprehensive instructions on how to set up a Storyblok space and connect it to your React project.

Ultimate Tutorial

Are you looking for a hands-on, step-by-step tutorial? The Next.js Ultimate Tutorial has you covered! It provides comprehensive instructions on building a complete, multilingual website using Storyblok and Next.js from start to finish.

Installation

Install @storyblok/react:

``bash
npm install @storyblok/react
// yarn add @storyblok/react
`

> ⚠️ This SDK uses the Fetch API under the hood. If your environment doesn't support it, you need to install a polyfill like isomorphic-fetch. More info on storyblok-js-client docs.

$3

Install the file from the CDN:

`html

`

Initialization

Register the plugin on your application and add the access token of your Storyblok space. You can also add the apiPlugin in case that you want to use the Storyblok API Client:

`js
import { apiPlugin, storyblokInit } from "@storyblok/react";

/* Import your components /
import Page from "./components/Page";
import Teaser from "./components/Teaser";
// import FallbackComponent from "./components/FallbackComponent";

storyblokInit({
accessToken: "YOUR_ACCESS_TOKEN",
use: [apiPlugin],
components: {
page: Page,
teaser: Teaser,
},
// bridge: false,
// apiOptions: {},
// richText: {},
// enableFallbackComponent: false,
// customFallbackComponent: FallbackComponent,
});
`

> Note: This is the general way for initalizing the SDK, the initialization might be a little different depending upon the framework. You can see how everything works according to the framework in their respective sections below.

Add all your components to the components object in the storyblokInit function.

That's it! All the features are enabled for you: the _Api Client_ for interacting with Storyblok CDN API, and _Storyblok Bridge_ for real-time visual editing experience.

> You can enable/disable some of these features if you don't need them, so you save some KB. Please read the "Features and API" section

Region parameter

Possible values:

- eu (default): For spaces created in the EU
- us: For spaces created in the US
- ap: For spaces created in Australia
- ca: For spaces created in Canada
- cn: For spaces created in China

Full example for a space created in the US:

`js
import { apiPlugin, storyblokInit } from "@storyblok/react";

storyblokInit({
accessToken: "YOUR_ACCESS_TOKEN",
use: [apiPlugin],
apiOptions: {
region: "us",
},
components: {},
});
`

> Note: For spaces created in the United States or China, the region parameter must be specified.

@storyblok/react does three actions when you initialize it:

- Provides a getStoryblokApi object in your app, which is an instance of storyblok-js-client.
- Loads the Storyblok Bridge for real-time visual updates.
- Provides a storyblokEditable function to link editable components to the Storyblok Visual Editor.

For every component you've defined in your Storyblok space, call the storyblokEditable function with the blok content:

`js
import { storyblokEditable } from "@storyblok/react";

const Feature = ({ blok }) => {
return (


export default Feature;
`

Where blok is the actual blok data coming from Storyblok's Content Delivery API.

> Note: The storyblokEditable function works the same way for all the frameworks and components created.

Getting Started

This SDK provides you the support to work with React and all React Frameworks such as Next.js, Remix etc. Depending upon these different frameworks and versions, the way to use the SDK and the functionalities it provides differ.

Below is the guide and examples on how to use it with different frameworks -

$3

The initalization remains the same when you work with React. You can intialze the SDK in the index.js file. Please refer to the 'Initialization' section above to read more.

$3

Use useStoryblok to fetch the content as well as enable live editing. You need to pass the slug as the first parameter, apiOptions as the second parameter, and bridgeOptions as the third parameter, which is optional if you want to set the options for the bridge by yourself. Check the available apiOptions (passed to storyblok-js-client) and bridgeOptions (passed to the Storyblok Bridge).

`js
import { StoryblokComponent, useStoryblok } from "@storyblok/react";

function App() {
const story = useStoryblok("react", { version: "draft" });

if (!story?.content) {
return

export default App;
`

StoryblokComponent renders the route components dynamically, using the list of components loaded during the initialization inside the storyblokInit function.

This is how you can pass the Bridge options as a third parameter to useStoryblok:

`js
useStoryblok(
story.id,
{ version: "draft", resolveRelations: ["Article.author"] },
{
resolveRelations: ["Article.author"],
resolveLinks: "url",
preventClicks: true,
},
);
`

Check out our React Boilerplate here, or read on how to add Storyblok to React in 5 mins here
You can also take a look at the React Playground in this repo.

$3

When using Next.js 13 or 14 with the App Router, ensure that you include cache: "no-store" in your requests when fetching data from Storyblok. This prevents data caching, ensuring that you always receive the most up-to-date content from Storyblok.

For more details, refer to the Next.js documentation on opting out of caching.

> Note: In Next.js 15, this will no longer be necessary, as the default caching behavior has been adjusted based on community feedback.

#### Example

Here's how you can fetch data from Storyblok with cache: "no-store":

`typescript
export async function fetchData() {
const sbParams: ISbStoriesParams = { version: "draft" };

const storyblokApi: StoryblokClient = getStoryblokApi();

return storyblokApi.get(cdn/stories/home, sbParams, {
cache: "no-store", // This prevents Next.js 13, 14 default caching behaviour
});
}
`

Choosing the Right Export

@storyblok/react provides three different exports to meet different deployment and framework requirements:

$3

| Export | Use Case | Live Editing | Static Export Support |
| ---------------------- | ----------------------------------- | ------------ | --------------------- |
| @storyblok/react | Client-side rendering, SPA | ✅ | ✅ |
| @storyblok/react/ssr | Server-side rendering, static sites | ❌ | ✅ |
| @storyblok/react/rsc | React Server Components | ✅ | ❌ |

$3

Use @storyblok/react for:
- Single Page Applications (SPA)
- Client-side rendered React apps
- When you need live editing in browser-based applications

Use @storyblok/react/ssr for:
- Next.js static exports (output: 'export')
- Static site generation without live editing
- Server-side rendering where live editing isn't required
- Performance-critical scenarios where bundle size matters

Use @storyblok/react/rsc for:
- Next.js App Router with React Server Components
- When you need live editing with server components
- Modern React applications with server/client component separation

Next.js Static Export Support

If you're using Next.js with output: 'export' for static site generation, you must use the @storyblok/react/ssr export. The RSC export includes server actions that are incompatible with static exports.

$3

`js
// next.config.js
/* @type {import('next').NextConfig} /
const nextConfig = {
output: 'export', // Enables static export
};

module.exports = nextConfig;
`

$3

`js
// lib/storyblok.js
import { apiPlugin, storyblokInit } from "@storyblok/react/ssr"; // Use SSR export
import Page from "@/components/Page";
import Teaser from "@/components/Teaser";

export const getStoryblokApi = storyblokInit({
accessToken: "YOUR_ACCESS_TOKEN",
use: [apiPlugin],
components: {
page: Page,
teaser: Teaser,
},
});
`

`js
// app/page.js
import { StoryblokServerStory } from "@storyblok/react/ssr";
import { getStoryblokApi } from "@/lib/storyblok";

export default async function Home() {
const { data } = await fetchData();

return (


export async function fetchData() {
const storyblokApi = getStoryblokApi();
return storyblokApi.get(cdn/stories/home, { version: 'draft' });
}
`

> [!NOTE]
> The SSR export does not include live editing capabilities. Live editing requires client-side JavaScript that's incompatible with static exports.

Next.js using App Router

The components in the app directory are by default React Server Side Components. The SDK provides different approaches depending on your deployment needs:

- For static exports: Use @storyblok/react/ssr (no live editing)
- For dynamic apps: Use @storyblok/react/rsc (with live editing)

$3

You can enable Storyblok Visual Editor's live editing with React Server Components by using the StoryblokStory component, which automatically handles both content rendering and live editing bridge loading. The SDK allows you to take full advantage of the Live Editing while maintaining the performance benefits of Server Components.

> For live editing with RSC, always import @storyblok/react/rsc.

$3

When is bridge loading automatic?

- ✅ Using StoryblokStory: Automatically handles bridge loading and live editing
- ✅ Client-Side Components: When using StoryblokComponent or other client components that already load the bridge
- ❌ Pure StoryblokServerComponent: Manual bridge loading needed with StoryblokLiveEditing

Why does RSC need special handling?

In React Server Components environments where components are purely server-rendered, the Storyblok bridge script isn't automatically loaded on the client. The StoryblokStory component detects when running in the Visual Editor and loads the bridge script for you.

$3

Create a new file lib/storyblok.js and initialize the SDK. Make sure you export the getStoryblokApi function, which is an instance of storyblok-js-client that is shared by server components.

`js
// lib/storyblok.js
import Page from "@/components/Page";
import Teaser from "@/components/Teaser";
import { apiPlugin, storyblokInit } from "@storyblok/react/rsc";

export const getStoryblokApi = storyblokInit({
accessToken: "YOUR_ACCESS_TOKEN",
use: [apiPlugin],
components: {
teaser: Teaser,
page: Page,
},
});
`

$3

The getStoryblokApi function can now be used inside your Story components to fetch the data from Storyblok. In app/page.jsx, use it as follows:

`js
import { StoryblokClient, ISbStoriesParams } from '@storyblok/react/rsc';
import { StoryblokStory } from '@storyblok/react/rsc';
import { getStoryblokApi } from '@/lib/storyblok';

export default async function Home() {
const { data } = await fetchData();

return (


const storyblokApi: StoryblokClient = getStoryblokApi();
return storyblokApi.get(cdn/stories/home, sbParams);
}
`

The StoryblokStory component automatically:
- Renders your Storyblok content components on the server
- Loads the bridge script for live editing (when in Visual Editor)
- Handles live content updates via global cache
- Manages bridge registration and cleanup

Advanced: Bridge Options

You can pass bridge options for advanced configurations:

`jsx
const bridgeOptions = { resolveRelations: ['article.author'] };


`

Advanced: Manual Component Separation

For advanced use cases where you need more control, you can use the individual components:

`jsx
import { StoryblokServerComponent, StoryblokLiveEditing } from '@storyblok/react/rsc';

// Manual approach (only use if you need special control)


`

> [!NOTE]
> Most applications should use StoryblokStory for the best developer experience and automatic live editing support.

Important: Individual Content Components

When creating your individual Storyblok content components (like Page, Teaser, etc.), you must use StoryblokServerComponent for nested components. Import it from the same export you're using:

For RSC (with live editing):
`jsx
import {
storyblokEditable,
StoryblokServerComponent,
} from "@storyblok/react/rsc";

const Page = ({ blok }) => (


export default Page;
`

For SSR (static exports):
`jsx
import {
storyblokEditable,
StoryblokServerComponent,
} from "@storyblok/react/ssr";

const Page = ({ blok }) => (


export default Page;
`

> [!IMPORTANT]
> Always use StoryblokServerComponent for nested content components, even when you declare them as client components with "use client". This ensures proper server-side rendering.

> [!NOTE]
> To use this approach (with getStoryblokApi), you need to include the apiPlugin module when calling storyblokInit function. If you don't use apiPlugin, you can use your preferred method or function to fetch your data.

To try this setup, take a look at the Next.js RSC Playgrounds in this repo.

Next.js using Pages Router

In this section, we'll see how to use the React SDK with the pages directory approach.

The initalization remains the same when you work with Next.js. You can intialze the SDK in the _app.js file. Please refer to the 'Initialization' section above to read more.

$3

The SDK provides a getStoryblokApi object in your app, which is an instance of storyblok-js-client. This can be used to fetch the content from Storyblok. You can use it in functions like getStaticProps, getStaticPaths, getServerSideProps etc.

`js
import { getStoryblokApi } from "@storyblok/react";

// At the required place
const storyblokApi = getStoryblokApi();
const { data } = await storyblokApi.get("cdn/stories", { version: "draft" });
`

> Note: To use this approach, you need to include the apiPlugin module when calling storyblokInit function. If you don't use apiPlugin, you can use your preferred method or function to fetch your data.

$3

The SDK also provides you with the useStoryblokState hook. It works similarly to useStoryblok for live editing, but it doesn't fetch the content. Instead, it receives a story object as the first parameter. You can also pass the Bridge Options as the second parameter.

`js
import { StoryblokComponent, useStoryblokState } from "@storyblok/react";

export default function Home({ story: initialStory }) {
const story = useStoryblokState(initialStory);

if (!story.content) {
return

return ;
}
`

In this case, the story is being passed as a prop that can be coming from where the story is being fetched. A complete example would look like this-

`js
import {
getStoryblokApi,
StoryblokComponent,
useStoryblokState,
} from "@storyblok/react";

export default function Home({ story: initialStory }) {
const story = useStoryblokState(initialStory);

if (!story.content) {
return

export async function getStaticProps({ preview = false }) {
const storyblokApi = getStoryblokApi();
const { data } = await storyblokApi.get(cdn/stories/react, {
version: "draft",
});

return {
props: {
story: data ? data.story : false,
preview,
},
revalidate: 3600, // revalidate every hour
};
}
`

StoryblokComponent renders the route components dynamically, using the list of components loaded during the initialization inside the storyblokInit function.

Check out the code for the first part of our Next.js + Storyblok Ultimate Tutorial. Or you can also read on how to add Storyblok to a Next.js project in 5 minutes here

$3

If you are using the pages router, you might want to load your components per page, instead of all in the _app file.

If you load all components in the _app file with storyblokInit funciton, the JavaScript for all of those components will be loaded on every page, even on pages where most of these components might not be used.

A better approach is to load these components on a per-page basis, reducing the JS bundle for that page, improving your load time, and SEO.

Simply execute storyblokInit in the _app file as you did before, but omit the components object and the component imports like so:

`diff
import { storyblokInit, apiPlugin } from "@storyblok/react";

/* Import your components /
-import Page from "./components/Page";
-import Teaser from "./components/Teaser";

storyblokInit({
accessToken: "YOUR_ACCESS_TOKEN",
use: [apiPlugin],
- components: {
- page: Page,
- teaser: Teaser,
- },
});
`

After that, use the setComponent method in each of your pages, to only load the components you need for that particular page:

`diff
import React from "react";
import Teaser from "../components/teaser";
import Grid from "../components/grid";
import Page from "../components/page";
import Feature from "../components/feature";

import {
useStoryblokState,
StoryblokComponent,
+ setComponents,
} from "@storyblok/react";

export default function Home({
story: initialStory,
}: InferGetStaticPropsType) {

+ setComponents({
+ teaser: Teaser,
+ grid: Grid,
+ feature: Feature,
+ page: Page,
+ })

const story = useStoryblokState(initialStory);

if (!story.content) {
return

return ;
}
`

Features and API

You can choose the features to use when you initialize the plugin. In that way, you can improve Web Performance by optimizing your page load and save some bytes.

$3

You can use an apiOptions object. This is passed down to the storyblok-js-client config object:

`js
storyblokInit({
accessToken: "YOUR_ACCESS_TOKEN",
apiOptions: {
// storyblok-js-client config object
cache: { type: "memory" },
},
use: [apiPlugin],
components: {
page: Page,
teaser: Teaser,
grid: Grid,
feature: Feature,
},
});
`

If you prefer to use your own fetch method, just remove the apiPlugin and storyblok-js-client won't be added to your application.

`js
storyblokInit({});
`

$3

If you don't use registerStoryblokBridge, you still have access to the raw window.StoryblokBridge:

`js
const sbBridge = new window.StoryblokBridge(options);

sbBridge.on(["input", "published", "change"], (event) => {
// ...
});
`

Rendering Rich Text

You can render rich text fields by using the StoryblokRichText component:

`ts
import { StoryblokRichText, useStoryblok } from '@storyblok/react';

function App() {
const story = useStoryblok('home', { version: 'draft' });

if (!story?.content) {
return

Or you can have more control by using the useStoryblokRichText hook:

`ts
import { useStoryblokRichText, convertAttributesInElement } from '@storyblok/react';
import Codeblock from './Codeblock';

function App() {
const { render } = useStoryblokRichText({
// options like resolvers
});

const html = render(doc);
const formattedHtml = convertAttributesInElement(html as React.ReactElement); // JSX

return (


For a comprehensive list of options you can provide to the useStoryblokRichText, please consult the Full options documentation.

$3

You can override the default resolvers by passing a resolvers prop to the StoryblokRichText component, for example, to use NextJS Link component or add a custom codeblok component:

`ts
import { StoryblokRichText, useStoryblok, MarkTypes, type StoryblokRichTextNode } from '@storyblok/react';
import Link from 'next/link';
import CodeBlock from './components/CodeBlock';

function App() {
const story = useStoryblok('home', { version: 'draft' });

if (!story?.content) {
return

> [!WARNING]
> The legacy renderRichText is soon to be deprecated. We recommend migrating to the new approach described above instead.

You can easily render rich text by using the renderRichText function that comes with @storyblok/react:

`js
import { renderRichText } from "@storyblok/react";

const renderedRichText = renderRichText(blok.richtext);
`

You can set a custom Schema and component resolver globally at init time by using the richText init option:

`js
import { RichTextSchema, storyblokInit } from "@storyblok/react";
import cloneDeep from "clone-deep";

const mySchema = cloneDeep(RichTextSchema); // you can make a copy of the default RichTextSchema
// ... and edit the nodes and marks, or add your own.
// Check the base RichTextSchema source here https://github.com/storyblok/storyblok-js-client/blob/main/src/schema.ts

storyblokInit({
accessToken: "",
richText: {
schema: mySchema,
resolver: (component, blok) => {
switch (component) {
case "my-custom-component":
return

You can also set a custom Schema and component resolver only once by passing the options as the second parameter to renderRichText function:

`js
import { renderRichText } from "@storyblok/react";

renderRichText(blok.richTextField, {
schema: mySchema,
resolver: (component, blok) => {
switch (component) {
case "my-custom-component":
return

By default, @storyblok/react returns an empty