Updating a Frontastic component schema

As you know, a Frontastic component schema basically defines what input options are available for a Frontastic component in the Frontastic studio. Once it's uploaded, you can make changes to the existing schema by uploading a new version of the schema but it has to have the same Frontastic component name.

We currently don't have in place a check to make sure an updated schema is Backwards Compatible so for now you'll need to check that yourself.

To make sure it's Backwards Compatible, you need to make sure that all the configurations you currently have in place for your Frontastic component (the defaults are the same and it basically behaves like before) are kept and that any new ones are optional.

Let's say you have a menu Frontastic component. You upload that schema to the Frontastic studio with the essential things for a menu item: having a title and a link to which page folder they're going to. You now want to add a configuration that can highlight a menu item. So when you update the schema, it must still contain the title and link but it would now have the highlight as optional so it would default to false. This will ensure it's Backward Compatible and behaves like it did before but now with the option of adding a highlight to it.

We do have a way that you can test the new version of your schema before uploading it to the Frontastic studio, the checking an updated schema article shows you how.

If you want to completely rework a Frontastic component schema, you can but the only option would be to copy the current schema and rename it (by adding 'version 2', for example). This then gives you the freedom to create an entirely different Frontastic component in its place. You'll need to keep in mind that for this Frontastic component to be updated on your site, your team will have to go through all pages where the old version of the Frontastic component is used and replace it with the new version. To minimize this update, you could reuse the React components that were used to render the old version of the Frontastic component to the new one (or the opposite, so the new one to the old one). This means that you're migrating your Frontastic component code to a new behavior but you're translating how the old schema looked on a code basis to a new visualization as it's possible to have 2 Frontastic component schemas referring to the same code in your project.

Let's look at an example:
Say that you have an existing Frontastic component where a single image can be selected in the Frontastic studio. Now you want to update this and make it so that multiple images can be selected. You can upload a new version of that Frontastic component and in the code, you can translate the single image into a list of images. Then you can use the new code for the old version too and it ensures that the old Frontastic component will work if it happens to be used on an old page that still needs to be browsable for SEO. Then you can make it Backwards Compatible on your own code and then you don't need to maintain all this old code anymore.

See the Frontastic schema article for best practices when creating a schema.


Did this page help you?