Skip to content

Interface: CustomSetting ​

Extends ​

Properties ​

children ​

children: ReactNode


defaultValue? ​

optional defaultValue?: unknown

A value to use if no value is provided

Inherited from ​

BaseSettingItem.defaultValue


disabled? ​

optional disabled?: boolean

Whether this setting is disabled

Inherited from ​

BaseSettingItem.disabled


disableWith? ​

optional disableWith?: string

The id of another setting that disables this setting

Inherited from ​

BaseSettingItem.disableWith


enableWith? ​

optional enableWith?: string

The id of another setting that is required to use this one

Inherited from ​

BaseSettingItem.enableWith


hidden? ​

optional hidden?: boolean

Whether the setting should be hidden

Inherited from ​

BaseSettingItem.hidden


id ​

id: string

An identifier used for callbacks

Inherited from ​

BaseSettingItem.id


inline? ​

optional inline?: boolean

Whether the input should render inline with the name (this is false by default for radio type)

Inherited from ​

BaseSettingItem.inline


name? ​

optional name?: string

The visual name to display

Inherited from ​

BaseSettingItem.name


note? ​

optional note?: string

The visual description to display

Inherited from ​

BaseSettingItem.note


type ​

type: "custom"

Overrides ​

BaseSettingItem.type