Choose your preferred SSG:
Choose your preferred SSG:

Structures reference

Each key under the key _structures will have the following options:

style - String (modal or select)

Defines whether the items are shown to your editors in a select menu (select, default) or a modal pop up window (modal).

id_key - String

Defines what key should be used to detect which structure an item is. If this key is not found in the array item, a comparison of key names is used (default _type).

values - Array

Defines what values are available when the add button is clicked. See reference below for available options.

Each array item in values will have the following options:

label - String

Used in the array interface to display what kind of items editors can add.

description - String

Used in the array interface as subtext to describe the items editors can add.

default - Boolean

If set to true, this item will be considered the default type for this structure. If the type of a value within a structure cannot be inferred based on its id_key or matching fields, then it will fall back to this item.

If multiple items have default set to true, only the first item will be used.

icon - String (Material Design icon name)

An icon used when displaying the structure (default multiline).

image - String

Path to an image in your source files used when displaying the structure. Can be either a source (has priority) or output path.

preview_image - String

Path to an image in your source files used when displaying the structure. Is not used for image previews after initial selection. Can be either a source (has priority) or output path.

image_size - String (cover, contain, or padded)

Defines how the image is displayed within its containing box.

tags - Array

Used to group and filter items when selecting from a modal.

value - Object

The actual value used when items are added after selection

text_key - String

Controls what key within the value is used for the display text on unopened object and array inputs. Defaults to the label.

subtext_key - String

Controls what key within the value is used for the supporting text on unopened object and array inputs. Defaults to using the first non-empty value (prioritizing text-based values).

Subtext is hidden if text and subtext is the same. If there’s no text, subtext is used instead.

image_key - String

Controls what key within value is used to display a preview image on unopened object and array inputs. Defaults to using image. If no image is found, icon is displayed instead.

Was this article helpful? or Suggest an improvement >

Related articles