Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines a single extension option.

Hierarchy

  • Option

Index

Properties

defaultValue?: string | boolean

The default value of the option. If ommitted, string options default to the empty string, boolean options default to true, and multiple options default to the top item in the list. A password field may not have a default value.

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.

type: "string" | "boolean" | "multiple" | "password" | "heading"

The kind of option, one of:

  • string: a text box for free text entry,
  • boolean: a check box,
  • multiple: multiple-choice drop-down with predefined options,
  • password: a password entry field (passwords are stored in user's keychain instead of preferences),
  • heading: adds a heading in the user interface, but does not actually define an option
valueLabels?: LocalizableString[]

Display names corresponding to the entries in the values array. These are shown in the option UI. If ommitted, the raw value strings are shown instead.

values?: string[]

The possible values for a multiple option.

Generated using TypeDoc