Updating a Frontastic component schema

As you know, a Frontastic componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. schema basically defines what input options are available for a Frontastic componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. in the Frontastic studioFrontastic studio - The interface you use to manage, build, and edit all areas of your project and commerce sites. Previously known as `backstage`.. 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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. 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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. (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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code.. You upload that schema to the Frontastic studioFrontastic studio - The interface you use to manage, build, and edit all areas of your project and commerce sites. Previously known as `backstage`. with the essential things for a menu item: having a title and a link to which page folderpage folder - A way of structuring the pages within a project and forms the URL structure – they can contain sub-folders. Known as `node` in code. 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 studioFrontastic studio - The interface you use to manage, build, and edit all areas of your project and commerce sites. Previously known as `backstage`., the checking an updated schema article shows you how.

If you want to completely rework a Frontastic componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. 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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. in its place. You'll need to keep in mind that for this Frontastic componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. to be updated on your site, your team will have to go through all pages where the old version of the Frontastic componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. 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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. to the new one (or the opposite, so the new one to the old one). This means that you're migrating your Frontastic componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. 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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. schemas referring to the same code in your project.

Let's look at an example:
Say that you have an existing Frontastic componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. where a single image can be selected in the Frontastic studioFrontastic studio - The interface you use to manage, build, and edit all areas of your project and commerce sites. Previously known as `backstage`.. 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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. 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 componentFrontastic component - A customizable building block that's used together with other components to create a commerce site. Known as `tastic` for short in code. 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 schemaschema - The framework behind a Frontastic component and the fields that are available within the Frontastic studio..


Did this page help you?