Skip to main content

SettingsTreeField

type SettingsTreeField = SettingsTreeFieldValue & object;

A settings tree field specifies the input type and the value of a field in the settings editor.

Type Declaration​

caption?​

optional caption?: string;

Optional caption.

disabled?​

optional disabled?: boolean;

True if the field is disabled.

help?​

optional help?: string;

Optional help text to explain the purpose of the field.

label​

label: string;

The label displayed alongside the field.

readonly?​

optional readonly?: boolean;

True if the field is readonly.

error?​

optional error?: string;

Optional message indicating any error state for the field.

warning?​

optional warning?: string;

Optional message indicating any warning state for the field. This message is not displayed when an error message is present.