Interface: SwitchLabelOptions

Defined in: src/sdk/fmc/components/SwitchLabel.ts:8

Switch label options

Extends

• EditableFieldOptions<number>

Properties

activeStyle?

optional activeStyle: string

Defined in: src/sdk/fmc/components/SwitchLabel.ts:13

Style class applied to the active option string only

---

caret?

optional caret: "left" | "none" | "right"

Defined in: src/sdk/fmc/components/SwitchLabel.ts:16

The position of the caret to display. Defaults to none.

---

clearScratchpadOnSelectedHandled?

optional clearScratchpadOnSelectedHandled: boolean

Defined in: src/sdk/fmc/components/FmcComponent.ts:31

Whether to clear the s-pad when onSelected returns a string or true. Defaults to true.

Inherited from

EditableFieldOptions.clearScratchpadOnSelectedHandled

---

disabled?

optional disabled: boolean | () => boolean

Defined in: src/sdk/fmc/components/FmcComponent.ts:10

Disables this component, not handling any lsk events.

Inherited from

EditableFieldOptions.disabled

---

formatter

formatter: FmcComponentFormatter<number>

Defined in: src/sdk/fmc/components/DisplayField.ts:14

Formatter object

Inherited from

EditableFieldOptions.formatter

---

onDelete()?

optional onDelete: () => Promise<string | boolean>

Defined in: src/sdk/fmc/components/FmcComponent.ts:41

Handler for an LSK pressed in DELETE mode

If the return value is:

• true -> the handler is considered to have handled the call, and no further handlers will be called
• false -> the handler is not considered to have handled the call, and the next handlers will be called
• string -> the value is shown in the scratchpad, and the handler is considered to have handled the call

Returns

Promise<string | boolean>

Inherited from

EditableFieldOptions.onDelete

---

onSelected()?

optional onSelected: (scratchpadContents) => Promise<string | boolean>

Defined in: src/sdk/fmc/components/FmcComponent.ts:26

Handler for an LSK pressed where the component is. This is the second priority in terms of handling, after the FmcPage and before the component class onLsk function.

This should be used in either of those two cases:

• the component does not take user input but has LSK interactivity
• the component takes user input, but it is not validated (instead of using an InputField)

If the return value is:

• true -> the handler is considered to have handled the call, and no further handlers will be called
• false -> the handler is not considered to have handled the call, and the next handlers will be called
• string -> the value is shown in the scratchpad, and the handler is considered to have handled the call

Parameters

Parameter	Type
scratchpadContents	string

Returns

Promise<string | boolean>

Inherited from

EditableFieldOptions.onSelected

---

optionStrings

optionStrings: readonly string[]

Defined in: src/sdk/fmc/components/SwitchLabel.ts:10

String names of possible options, in order

---

prefix?

optional prefix: string

Defined in: src/sdk/fmc/components/DisplayField.ts:17

Text shown before the value (can be used for start indentation)

Inherited from

EditableFieldOptions.prefix

---

separator?

optional separator: "slash" | "arrows"

Defined in: src/sdk/fmc/components/SwitchLabel.ts:19

The separator to show between the options, arrows are highlighted when next to active option

---

style?

optional style: string | (value) => string

Defined in: src/sdk/fmc/components/DisplayField.ts:23

The style to apply to the value. MUST BE WRAPPED IN SQUARE BRACKETS.

Inherited from

EditableFieldOptions.style

---

suffix?

optional suffix: string

Defined in: src/sdk/fmc/components/DisplayField.ts:20

Text shown after the value (can be used for end indentation)

Inherited from

EditableFieldOptions.suffix