Integrating Symbols
Symbols are a type of section model you can integrate for editing on your site or app. They help you elegantly reuse content across many Builder Pages and Sections. For more information, see Intro to Symbols.
Prerequisites
To follow along with this tutorial, you should have the following:
- a Builder account
- an app in the framework of your choice with the appropriate Builder SDK installed
- a Symbol model that you've already created
- you should have already integrated page building or section building
Tip: If you need to create an app, follow the steps for your framework in the Create an app section of Integrating Page Building.
Add symbol editing to your app
First, create a special page on your site specifically for symbol editing. This is what the Builder preview will open when creating and editing symbols. It's important this be on a URL directly on your site so all previewing and editing is accurate.
This guide calls this page /edit-symbol.
Update your symbol preview URL
Go to Models and choose the Symbol model.
Tip: If you don't have Symbol here, make sure that you've met the prerequisite of having created a Symbol. For step-by-step instructions, see How to Make a Symbol.
Enter your site domain at this new /edit-symbol path you just created, for example https://my-site.com/edit-symbol.
You can use localhost when testing locally, then change to a hosted URL like your QA or production URL once your code updates have been deployed.
Looking to hire a 3rd party to help with your project?
Submit a project request and our partnerships team will reach out to connect you with an Expert from our partner ecosystem.