#Interface: ApiVisualEditorCheckboxDef

Defined in: extensions/visualeditor.ts:43

One field of the edit form (checkboxesDef.wpMinoredit, wpWatchthis, wpWatchlistExpiry).

#Properties

#class?

optional class?: string

Defined in: extensions/visualeditor.ts:63

PHP class of the OOUI widget; set for the wpWatchlistExpiry dropdown.

---

#default?

optional default?: string | boolean

Defined in: extensions/visualeditor.ts:84

Whether the box starts checked — or the preselected expiry string for the wpWatchlistExpiry dropdown. A real boolean under fv2 for checkboxes.

---

#id?

optional id?: string

Defined in: extensions/visualeditor.ts:45

Element id, e.g. wpMinoredit.

---

#invisibleLabel?

optional invisibleLabel?: true

Defined in: extensions/visualeditor.ts:78

Label rendered invisibly (wpWatchlistExpiry only).

---

#label-id?

optional label-id?: string

Defined in: extensions/visualeditor.ts:54

DOM id of the labelled element.

---

#label-message?

optional label-message?: string

Defined in: extensions/visualeditor.ts:48

Message key holding the label.

---

#legacy-name?

optional legacy-name?: string

Defined in: extensions/visualeditor.ts:57

Legacy form field name.

---

#options?

optional options?: object[]

Defined in: extensions/visualeditor.ts:66

Dropdown options as label/value pairs (wpWatchlistExpiry only).

#data?

optional data?: string

Value submitted when the option is chosen.

#label?

optional label?: string

Option text shown in the dropdown.

---

#title-message?

optional title-message?: string

Defined in: extensions/visualeditor.ts:51

Message key for the label's title attribute; hook-provided checkboxes only.

---

#tooltip?

optional tooltip?: string

Defined in: extensions/visualeditor.ts:60

Access-key/tooltip message slug, e.g. minoredit.

---

#value-attr?

optional value-attr?: string

Defined in: extensions/visualeditor.ts:75

Widget config option carrying the current value (wpWatchlistExpiry only).