The problem

When working with Storyblok there are two ways to set up your Next.js app if you use the app router. The first way is to wrap your entire app in a provider which then takes care of updating the app when you edit anything in the preview environment of Storyblok, thus giving you live editing. Live editing is a cool feature because an editor can directly see the changes they made without constantly saving the page.

The second approach keeps everything server-side. This is nice because we can then leverage the full power of server components. But this approach comes with a big limitation... you lose the live editing support and the editor can only see their changes after they've hit the save button.

Or is there a way...

I found this Gist from someone who stumbled across the same issue and solved it with a clever solution. I expanded on their solution and replaced their database (@vercel/kv) with something free and local. Let's dive in on how I did it!

The solution

When you are in the live editing environment of Storyblok, they add a class to the browser's window object called StoryblokBridge. This bridge allows you to listen to live editing events happening with on():

const sbBridge = new window.StoryblokBridge(options)

sbBridge.on(['input', 'published', 'change  '], (event) => {
  const story = event.story
  // ...
})

The event returned contains the updated story with the live editing data the user entered. Awesome! We can use this live story and save it somewhere, then revalidate the page using Next.js' revalidatePath() API. Let's see how:

Let's first tackle the "save it somewhere" part of the solution. I used node-cache for this.

Create an instrumention.ts file in the root or src folder of your project:

import type NodeCache from 'node-cache'

export async function register() {
  const NodeCache = (await import('node-cache')).default
  const config = {
    stdTTL: 100,
  }

  global.storyblokCache = new NodeCache(config)
}

Add this to next.config:

 experimental: {
  instrumentationHook: true,
 },

This setup makes sure the cache won't be reset with each request, only on server startup.

Next, let's take a look at how we get the live editing data from Storyblok and save it in this cache. For this we first need to create a custom Storyblok bridge:

export const registerStoryblokBridge = ({ onInput }) => {
  const isServer = typeof window === 'undefined'
  const isBridgeLoaded = !isServer && typeof window.storyblokRegisterEvent !== 'undefined'

  if (!isBridgeLoaded) {
    return
  }

  window.storyblokRegisterEvent(() => {
    const sbBridge = new window.StoryblokBridge()
    sbBridge.on(['input'], (event) => {
      if (!event?.story) return

      onInput(event.story)
    })
  })
}

This function listens to live editing events, as we found out above, and makes a callback with the story containing the latest live editing data.

We then use this function in a client component

"use client";

import { previewUpdateAction } from "@/actions/previewUpdateAction";
import { registerStoryblokBridge } from "@/utils/storyblok";
import { useEffect, startTransition } from "react";

export const StoryblokPreviewSyncer = ({ pathToRevalidate }) => {
  function handleInput(story) {
    startTransition(() =>
      previewUpdateAction({
        story,
        pathToRevalidate,
      })
    );
  }

  useEffect(() => {
    registerStoryblokBridge({
      onInput: handleInput,
    );
  }, []);

  return null;
};

This client component makes sure the window event is fired with useEffect. The handleInput function uses React's startTransition to call a Next.js Server Action containing the latest data. Let's find out what this server action looks like.

'use server'

import { revalidatePath } from 'next/cache'
import { ISbStoryData } from '@storyblok/react'

export async function previewUpdateAction({ story, pathToRevalidate }) {
  if (!story) {
    console.error('No story provided')
    return
  }

  try {
    global.storyblokCache.set(story.slug, JSON.stringify(story))

    if (pathToRevalidate) {
      revalidatePath(pathToRevalidate)
    }
  } catch (error) {
    console.log(error)
  }
}

This function takes the story with the live editing data and saves it to our cache. It then calls revalidatePath to make sure Next.js knows it needs to update the page.

We now only need one more piece to solve the puzzle and that is the function that takes care of fetching the story:

export const getStoryblokData = async (slug) => {
  const storyblokApi = getStoryblokApi()

  try {
    const story = global.storyblokCache?.get(slug)

    if (!story) {
      const result = await storyblokApi.get(`cdn/stories/${slug}`, { version: 'draft' })

      return result.data.story
    }

    return JSON.parse(story)
  } catch (e) {
    console.log(e)
  }
}

This function first tries to fetch the story from the database (this would be the story with the latest live editing). If this fails it falls back to the Storyblok API.

We can then use this function on a page together with our <StoryblokPreviewSync /> component:

import { StoryblokComponent } from '@storyblok/react/rsc'

import { StoryblokPreviewSyncer } from '@/components/StoryblokPreviewSync'
import { getStoryblokData } from '@/utils/storyblok'

export default async function Home() {
  const story = await fetchData()

  return (
    <main>
      <StoryblokPreviewSyncer pathToRevalidate={'/'} />
      <StoryblokComponent blok={story?.content} />
    </main>
  )
}

function fetchData() {
  return getStoryblokData('home')
}

There you go! Now you should have live editing support, with the full power of React Server Components!

Upcoming events

Coven of Wisdom - Herentals - Winter `24 edition
Worstelen jij en je team met automated testing en performance? Kom naar onze meetup waar ervaren sprekers hun inzichten en ervaringen delen over het bouwen van robuuste en efficiënte applicaties. Schrijf je in voor een avond vol kennis, heerlijk eten en een mix van creativiteit en technologie! 🚀 18:00 – 🚪 Deuren open 18:15 – 🍕 Food & drinks 19:00 – 📢 Talk 1 20:00 – 🍹 Kleine pauze 20:15 – 📢 Talk 2 21:00 – 🙋‍♀️ Drinks 22:00 – 🍻 Tot de volgende keer? Tijdens deze meetup gaan we dieper in op automated testing en performance. Onze sprekers delen heel wat praktische inzichten en ervaringen. Ze vertellen je hoe je effectieve geautomatiseerde tests kunt schrijven en onderhouden, en hoe je de prestaties van je applicatie kunt optimaliseren. Houd onze updates in de gaten voor meer informatie over de sprekers en hun specifieke onderwerpen. Over iO Wij zijn iO: een groeiend team van experts die end-to-end-diensten aanbieden voor communicatie en digitale transformatie. We denken groot en werken lokaal. Aan strategie, creatie, content, marketing en technologie. In nauwe samenwerking met onze klanten om hun merken te versterken, hun digitale systemen te verbeteren en hun toekomstbestendige groei veilig te stellen. We helpen klanten niet alleen hun zakelijke doelen te bereiken. Samen verkennen en benutten we de eindeloze mogelijkheden die markten in constante verandering bieden. De springplank voor die visie is talent. Onze campus is onze broedplaats voor innovatie, die een omgeving creëert die talent de ruimte en stimulans geeft die het nodig heeft om te ontkiemen, te ontwikkelen en te floreren. Want werken aan de infinite opportunities van morgen, dat doen we vandaag.
September 26 | Coven of Wisdom Herentals
Go to page for Coven of Wisdom - Herentals - Winter `24 edition
Mastering Event-Driven Design
PLEASE RSVP SO THAT WE KNOW HOW MUCH FOOD WE WILL NEED Are you and your team struggling with event-driven microservices? Join us for a meetup with Mehmet Akif Tütüncü, a senior software engineer, who has given multiple great talks so far and Allard Buijze founder of CTO and founder of AxonIQ, who built the fundaments of the Axon Framework. RSVP for an evening of learning, delicious food, and the fusion of creativity and tech! 🚀 18:00 – 🚪 Doors open to the public 18:15 – 🍕 Let’s eat 19:00 – 📢 Getting Your Axe On Event Sourcing with Axon Framework 20:00 – 🍹 Small break 20:15 – 📢 Event-Driven Microservices - Beyond the Fairy Tale 21:00 – 🙋‍♀️ drinks 22:00 – 🍻 See you next time? Details: Getting Your Axe On - Event Sourcing with Axon Framework In this presentation, we will explore the basics of event-driven architecture using Axon Framework. We'll start by explaining key concepts such as Event Sourcing and Command Query Responsibility Segregation (CQRS), and how they can improve the scalability and maintainability of modern applications. You will learn what Axon Framework is, how it simplifies implementing these patterns, and see hands-on examples of setting up a project with Axon Framework and Spring Boot. Whether you are new to these concepts or looking to understand them more, this session will provide practical insights and tools to help you build resilient and efficient applications. Event-Driven Microservices - Beyond the Fairy Tale Our applications need to be faster, better, bigger, smarter, and more enjoyable to meet our demanding end-users needs. In recent years, the way we build, run, and operate our software has changed significantly. We use scalable platforms to deploy and manage our applications. Instead of big monolithic deployment applications, we now deploy small, functionally consistent components as microservices. Problem. Solved. Right? Unfortunately, for most of us, microservices, and especially their event-driven variants, do not deliver on the beautiful, fairy-tale-like promises that surround them.In this session, Allard will share a different take on microservices. We will see that not much has changed in how we build software, which is why so many “microservices projects” fail nowadays. What lessons can we learn from concepts like DDD, CQRS, and Event Sourcing to help manage the complexity of our systems? He will also show how message-driven communication allows us to focus on finding the boundaries of functionally cohesive components, which we can evolve into microservices should the need arise.
September 19 | Coven of Wisdom - Utrecht
Go to page for Mastering Event-Driven Design
The Leadership Meetup
PLEASE RSVP SO THAT WE KNOW HOW MUCH FOOD WE WILL NEED What distinguishes a software developer from a software team lead? As a team leader, you are responsible for people, their performance, and motivation. Your output is the output of your team. Whether you are a front-end or back-end developer, or any other discipline that wants to grow into the role of a tech lead, RSVP for an evening of learning, delicious food, and the fusion of leadership and tech! 🚀 18:00 – 🚪 Doors open to the public 18:15 – 🍕 Let’s eat 19:00 – 📢 First round of Talks 19:45 – 🍹 Small break 20:00 – 📢 Second round of Talks 20:45 – 🙋‍♀️ drinks 21:00 – 🍻 See you next time? First Round of Talks: Pixel Perfect and Perfectly Insane: About That Time My Brain Just Switched Off Remy Parzinski, Design System Lead at Logius Learn from Remy how you can care for yourself because we all need to. Second Round of Talks: Becoming a LeadDev at your client; How to Fail at Large (or How to Do Slightly Better) Arno Koehler Engineering Manager @ iO What are the things that will help you become a lead engineer? Building Team Culture (Tales of trust and positivity) Michel Blankenstein Engineering Manager @ iO & Head of Technology @ Zorggenoot How do you create a culture at your company or team? RSVP now to secure your spot, and let's explore the fascinating world of design systems together!
June 26 | Coven of Wisdom - Amsterdam
Go to page for The Leadership Meetup

Storyblok live editing with Next.js App Router and React Server Components

The problem

The solution

Upcoming events

Coven of Wisdom - Herentals - Winter `24 edition

Mastering Event-Driven Design

The Leadership Meetup

Share

Jobs

Senior Web Developer

Senior .NET Developer

Lead Front-end Developer

(senior) Front-end Developer

View all jobs