A boolean option.

interface BooleanOption {
    defaultValue?: boolean;
    description?: LocalizableString;
    icon?: string;
    identifier: string;
    label?: LocalizableString;

Hierarchy (view full)


defaultValue?: boolean

The default value of the option. If omitted, boolean options default to true.

description?: LocalizableString

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

icon?: string

An icon for this option. It is only displayed for boolean options, next to the check box.

identifier: string

An identifying string for this option.

A short label for this option.