GuidesUpgrading

Upgrading to 0.29.0

If you haven’t upgraded to 0.28.0, please review the 0.28.0 upgrade guide first.

v0.29.0 of the runtime includes performance improvements for fetching snapshots from Makeswift, as well as a rebuild of the underlying mechanisms used to generate CSS and apply dynamic style updates to Makeswift content.

Refer to the official release notes for the full list of changes.

Breaking Changes

React and Next.js Version Requirements

Your host must now be running React 19.

If you’re using a Next.js host, it must be on Next.js 15 or later.

RootStyleRegistry

cacheKey prop renamed to classNamePrefix

  • The optional cacheKey prop has been renamed. Previous runtime versions passed cacheKey into an Emotion cache, where it was used to prefix CSS class names. If you wish to continue using a custom class name prefix, you should now use the optional classNamePrefix prop (defaults to ms).

RootStyleRegistry is now required for Next.js Pages Router

If your host is on Next.js Pages Router, the Makeswift integration previously did not require a RootStyleRegistry.

This is no longer the case. A RootStyleRegistry must always be present in your application’s Makeswift provider tree as a child of the ReactRuntimeProvider in order for Makeswift content to render correctly:

- import { ReactRuntimeProvider } from '@makeswift/runtime/next'
+ import { ReactRuntimeProvider, RootStyleRegistry } from '@makeswift/runtime/next'
  <ReactRuntimeProvider {...{ runtime, siteVersion, locale }}>
+   <RootStyleRegistry>
      {children}
+   </RootStyleRegistry>
  </ReactRuntimeProvider>