This is the step-by-step upgrade guide from latest v2 (v 2.3.16) to v3.x
1. Translations structure on Page
translations array on the
Page object returned by
usePage isn't an array of strings anymore, but it is an array of objects with keys
This makes possible to create a language switch that stays at the current page, but in another language (where the slug may be different).
2. shouldRefreshText not needed
shouldRefreshText on sideEditProps which affect the style of (Rich)Texts isn't needed anymore. Since we removed it from the TypeScript interface, if you are using TypeScript you will receive a type error if you don't remove it.
3. Changes to leverage new features
3.1 Staging build hook
Based on your need and your Plan, you may want to add a Staging build web hook and set the proper permissions on your Editor users, so that now a user can just be able to trigger a re-deploy in staging.
3.2 Images aspect ratio
Based on your needs you can now set a fixed aspect ratio (
aspectRatio) on images to enforce it.
3.3 New RichText features
You can now have headings H1..H6 and Quote as features in your
RichText components and you can also use the new
RichTextExt component to use the plugin-based Rich Text and be able change any aspect of a plugin or even add new custom plugins.
You can now save Stories (bricks configurations with both the content and side props' values) for each Brick, so that your editors will be able to use them out of the box.
3.5 Bricks categorization and docs
You may now add a
tags to all of your Bricks to organize them and have a better search.
You can also add a
playgroundLinkLabel to have a link to external documentation in the Playground.
3.6 Backup and restore
You can now backup a React Bricks App content and restore it from the React Bricks Dashboard.