Interface PluginPreference

interface PluginPreference {
    default?: string;
    description?: string;
    name: string;
    options?: readonly DropdownOption[];
    required: boolean;
    title: string;
    type: PluginPreferenceType;
}

Index

Properties

default? description? name options? required title type

Properties

`Optional` `Readonly`default

default?: string

Default value (for checkbox: "true" / "false").

`Optional` `Readonly`description

description?: string

Optional longer description shown below the field.

`Readonly`name

name: string

Machine key stored in the host's config storage.

`Optional` `Readonly`options

options?: readonly DropdownOption[]

For dropdown type only — the available choices.

`Readonly`required

required: boolean

`Readonly`title

title: string

Human-readable label for the settings UI.

`Readonly`type

type: PluginPreferenceType