Models in Builder.io

Introduction

A model is a paradigm—a pattern for something else. Builder offers three kinds of models that define content types:

• A Page model: The basis for a full Page built in Builder.
• A Section model: The basis for a part of a Page.
• A Data model: Gives structure to a collection of data that you render as you choose.

You use these models as the defining source for content entries. By using models in Builder you can define what a Page, Section, or collection of Data is and use those models over and over to build your site and populate it with content. And you can create as many models as you like.

All models in Builder support:

• A/B Testing: Test different versions of your content.
• Targeting: Deliver specific content to the right people.
• Scheduling: Publish your content at the right time.
• Roles and Permissions in a Space: Admins and Developers can edit models by default, but you can also specify permissions by content model using Custom Roles.

This means that you can granularly grant permissions, test, and precisely deliver content.

Using models to build your app

When you use models to build your app, you can create exactly the Pages, Sections, and Data specific to your use case with your integrated App.

Examples of models include:

1. A seasonal announcement banner placed on a page between certain dates.
2. Marketing tile targeting a specific persona on certain pages.
3. Blog authors whose profiles you want to link to from different parts of your site.

The following diagram shows a typical Builder documentation page. The left side navigation is a Section, the body of the document is a Page, and the font colors are stored in a Data content entry.

Architecture Best Practices

To build your site most efficiently, use this guide's best practices for: - Structuring your integrated app - Deciding what goes into Builder and what stays in your code

Structuring your integrated app

By using Builder's models with a few points in mind, you can establish a structure for your app that lends itself more readily to working in parallel. With this workflow, you can unblock teammates so that they can take care of more of their own needs to meet deliverables.

1. Use one Page model
   
   A model is like a cookie-cutter, a paradigm that you can use over and over again to create infinitely varied creations.
   
   Generally, you only need one Page model to reuse for multiple pages. A Page is distinct from a Section in that a Page requires a URL, while a Section does not.
2. Use Section models for parts of Pages
   
   A Section is a part of a Page; for example, a banner, a marketing section on a product page, or a hero.
   
   At Builder.io, we use Sections for the docs left side navigation, blog articles, and docs headers.
3. Use Data models for non-visual structured data
   
   Structured Data models are a key feature of any CMS, and best reserved for non-visual elements.
   
   In most cases, a Section Model is the preferred choice, except for things that truly are purely data; such as blog authors, product information, or other needs that are best as minimal, structured data.

Deciding what goes into Builder

When deciding what goes into Builder and what stays in code, consider these points.

The following tree shows this same decision-making process for determining what goes into Builder and what stays in code: