Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GroupFieldConfig

Hierarchy

Index

Properties

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 fields

fields?: FieldConfig[]

Fields to be grouped and hidden.

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 isExpanded

isExpanded?: boolean

Is the group expanded to show the fields?

Set to true to expand the group by default.

key

key: string

Key to reference the field in the data.

Optional label

label?: string

Label for the field in the editor.

Optional previewFields

previewFields?: string[]

Preview field keys.

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

If no fields are no preview will be shown for the group when collapsed.

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