Interface StringOption

A string-valued option.

interface StringOption {
    defaultValue?: string;
    description?: LocalizableString;
    identifier: string;
    label?: LocalizableString;
}

Hierarchy (view full)

Properties

defaultValue? description? identifier label?

Properties

Optional Readonly defaultValue

defaultValue?: string

The default value of the option. If omitted, string options default to the empty string.

Optional Readonly description

description?: LocalizableString

An optional longer explanantion of this option, to be shown in the UI.

Readonly identifier

identifier: string

An identifying string for this option.

Optional Readonly label

label?: LocalizableString

A short label for this option.

Settings

Member Visibility

Theme

On This Page

defaultValuedescriptionidentifierlabel