Content Types

Content Types represent the definition of how Pages, Posts, Fragments, or Components will display editable fields to Authors. The flexibility of Burdy's Content Types allows us to generate and build almost any data structure.

Viewing all content types is done by accessing the Content Types section in the side menu.

Content Types

Creating new Content-Type

Creating a new Content-Type is done by pressing New action in the Toolbar. After pressing it, Create New Panel will open.

The name is unique across all content types inside the same Burdy.

There are 4 main types:

  • Page - template used to define a schema for the Pages
  • Post - template used to define a schema for repeatable Posts inside Hierarchical Posts
  • Fragment - similar to pages, it defines a schema for the post of type Fragment
  • Component - reusable components that can be reused inside Custom Content-Type and Dynamic Zones. Components are not standalone templates
After creating content type of certain type it is not possible to change it later after pressing Create button.

By pressing Add Field button, a new Panel will appear prompting the user to select field type.

Out of the box, there are 17 field types split into two Categories, Core and Layout.

  • Core
    • Assets
    • Checkbox
    • Choice Group
    • Color Picker
    • Custom Component - a single section in your content where Authors can apply re-usable Components
    • Date Picker
    • Dropdown
    • Images
    • Number
    • Relation
    • Text
    • Rich Text (draftjs)
    • Text Editor (ace)
  • Layout
    • Group - nested objects
    • Repeatable - repeatable section/list of the configured objects
    • Tab - silent component not visible in Content API used only for organizing fields. Every field below a certain Tab is grouped under that specific tab
    • Dynamic Zone - section of a content where Authors can add a list of reusable components,
Layout fields are allowing us to organize and group content.
Both Group and Repeatable can be nested in each other creating even more complex types, For example, Arrays in the Objects in the Arrays.
Configuring Field

By clicking field type new Panel will appear allowing to Configure Field

Text Field Configuration

Each field has at least the Label and the Name for the configuration, other fields are field type-specific configurations. The label is a text that will be displayed to the author. Name is a field name that will be used to store the value of the field.

Upon clicking the button Add, the field will be added to the Content-Type:

This configuration will allow Editor to display the Text field of label Title to the Author.

Following the same pattern we are able to add more fields, organize fields using Groups, Tabs, and Repeatable and create a complex data structure.

For example complex data type:

This configuration will enable Editor to display complex field organization and structure:

Fields can be re-ordered by simply pressing arrows up / down or using Drag and Drop.

Updating Content-Type

Content-type can be updated by either clicking on the name in the list or selecting the content type and pressing Edit from the Toolbar. Update Panel will appear allowing users to edit Name or Fields.

It is not suggested to update the name of the content-type, especially if the component is used in the Zones and Custom Components.

Deleting Content-Type

Deleting content types is done by selecting content types from the list and pressing Delete from Toolbar.

A dialog will appear prompting the user to delete content types.

In case there are Pages, Posts, or Fragments that are using a specific content type, Delete will fail with a message that Content-Type is being used. New Checkbox will appear asking the user to Force Delete:

In case a user decides to Tick Force Delete and delete a post it will delete all selected content types and all posts that are using selected content types. Please note this action is not reversible.

Export / Import

In case we need to migrate content types across environments we can use Export and Import functionality.

To Export content types user will need to select content types and press an Export button in the Toolbar which will automatically download the JSON configuration of the selected content types.

To import configuration user will need to press the Import Button which will prompt user to upload JSON file containing previously exported content types JSON configuration.

After selecting a file either using Drag and Drop or clicking in the area and uploading from the computer, a dialog will ask users if they would like to override content types if they already exist. If the checkbox is not a ticket it will only create new content types that don't already exist in the environment.

Copyright © Burdy Technologies. All rights reserved.