Display Data Model

Defines how the blocks within a piece of content will be displayed. There can be multiple displays for each content template.

Sample JSON Data

      {
        "data": {
          "type": "displays",
          "id": "0ff656fe-5241-46ab-9b59-effd4b0ef30e",
          "attributes": {
            "title": "Full Article",
            "content": "<h1 class=\"article-title\">{ 'title' | display_block }</h1><div class=\"article-summary\">{ 'summary' | display_block }</div>",
            "description": null,
            "file-name": "full_article_display.liquid",
            "position": 1,
            "created-at": "2012-04-23T18:25:43.511Z",
            "updated-at": "2012-04-23T18:25:43.511Z"
          }
        }
      }

Attributes

Attribute Type Required Description
title string Yes Title of display for reference in editor.
content string Yes Template that will be used to display content based on blocks in this content template. May include Liquid markup relevant to displays.
description string No Description of display that will appear within editor interfaces.
file-name string No File name of display within theme folder.

If no value is provided, a default will be provided containing a lowercased and underscored version of title, followed by _display.liquid. (For example, if the title is “Full Article,” the defaule value will be full_article_display.liquid.

The file-name must contain a .liquid extension.
position integer Yes Order in which to list this display in the editor.
created-at date Read-only Records when display was created, localized to the current logged in user’s time zone.
updated-at date Read-only Records when display was last updated, localized to the current logged in user’s time zone.

Relationships

None.

Related