Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CheckboxFieldConfig

Selective Fields

Hierarchy

Index

Properties

Optional classes

classes?: string[]

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

Optional color

color?: string

Color for the color hint.

Optional default

default?: any

default value to use for the field.

Optional gradient

gradient?: ColorsConfig

Gradient color hint.

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.

key

key: string

Key to reference the field in the data.

Optional label

label?: string

Label for the field in the editor.

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.

Optional value

value?: any

Value when checked. If not defined the value is true when the checkbox is checked.

Optional valueUnchecked

valueUnchecked?: any

Value when the field is not checked.

Generated using TypeDoc