Skip to content

Layouts#

A layout is essentially a page with a specific flag, similar to “admin” pages used for emails and batch reports.

Layouts represent an ordered grouping of components and a snapshot of the content linked to those components at the time the layout was created. It’s important to note that this snapshot does not include the actual content but rather references to the IDs where the content for each component is stored.

Layouts serve as a quick starting point for building new pages within PageBuilder. Instead of manually adding components to a page, a layout provides pre-configured components, allowing store owners to customize them as needed. The goal of layouts is to provide visually appealing pages as a foundation, reducing the overall time required to create and customize content pages (e.g., SFNT, About Us, Landing Pages).

Provisioning#

<Page_Add>
    <Layout>true|false</Layout>     <!-- Optional, default is false (0). Only one of Layout or Admin can be true at a time -->
    <Admin>true|false</Admin>       <!-- Optional, default is false (0). Only one of Layout or Admin can be true at a time -->
</Page_Add>

<Page_Update code="existing">
    <Layout>true|false</Layout>     <!-- Optional, default is false (0). Only one of Layout or Admin can be true at a time -->
    <Admin>true|false</Admin>       <!-- Optional, default is false (0). Only one of Layout or Admin can be true at a time -->
</Page_Update>

In both the <Page_Add> and <Page_Update> operations, you can optionally set the Layout and Admin flags. However, only one of these can be true at any given time. By default, both are set to false.