Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListFieldConfig

Hierarchy

Index

Properties

Optional addLabel

addLabel?: string

Label for adding more list items.

Optional classes

classes?: string[]

Extra css classes to apply to the field in the editor.

Optional default

default?: any

default value to use for the field.

Optional emptyLabel

emptyLabel?: string

Label for when the list is empty.

Optional fields

fields?: FieldConfig[]

Field definitions for each item in the list.

Optional help

help?: string | Record<string, string>

Help string to display to assist user in understanding the expectations of the field.

In complex fields, this can be broken up into zones like validation rules.

Optional isComplex

isComplex?: boolean

Are the fields complex?

When set to true, the list will not use the 'Simple' mode for showing list items when there is only one field configured in the fields config.

key

key: string

Key to reference the field in the data.

Optional label

label?: string

Label for the field in the editor.

Optional previewField

previewField?: string

Preview field key.

When showing a preview of the list items, use this key to determine the value to show for the preview.

Optional previewFields

previewFields?: string[]

Preview field keys.

When showing a preview of the list items, use these keys to determine the value to show for the preview.

Optional previewType

previewType?: PreviewTypes

Control how the editor displays the preview for the list items.

type

type: string

Type of field. Used to create the correct field in the editor UI.

Optional validation

validation?: RuleConfig[] | Record<string, RuleConfig[]>

Validation rules that should be applied to the field.

In complex fields, this can be broken up into zone like help text.

Generated using TypeDoc