Skip to main content

Interface: ConfigField

User-editable value stored in the addon's configuration.

Properties

key

key: string

Stable key used by IPluginAPI.getConfig.


type

type: "number" | "boolean" | "text" | "password" | "select"

Editor used by the host configuration screen.


label

label: string

Human-readable field label.


default

default: string | number | boolean | readonly (string | number)[]

Value used before the user saves a custom value.


options?

optional options?: object[]

Allowed choices when type is select.

label

label: string

value

value: string | number


multiple?

optional multiple?: boolean

Allows a select field to store more than one choice.