Interface: ToggleLabelOptions
Toggle label options
Hierarchy
EditableFieldOptions
<boolean
>↳
ToggleLabelOptions
Properties
activeStyle
• Optional
activeStyle: string
Style class applied to the label text when its value is true
.
Defined in
src/sdk/fmc/components/ToggleLabel.ts:13
clearScratchpadOnSelectedHandled
• Optional
clearScratchpadOnSelectedHandled: boolean
Whether to clear the s-pad when onSelected
returns a string or true
. Defaults to true
.
Inherited from
EditableFieldOptions.clearScratchpadOnSelectedHandled
Defined in
src/sdk/fmc/components/FmcComponent.ts:31
disabled
• Optional
disabled: boolean
| () => boolean
Disables this component, not handling any lsk events.
Inherited from
Defined in
src/sdk/fmc/components/FmcComponent.ts:10
formatter
• formatter: FmcComponentFormatter
<boolean
>
Formatter object
Inherited from
EditableFieldOptions.formatter
Defined in
src/sdk/fmc/components/DisplayField.ts:14
onDelete
• Optional
onDelete: () => Promise
<string
| boolean
>
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 calledfalse
-> the handler is not considered to have handled the call, and the next handlers will be calledstring
-> the value is shown in the scratchpad, and the handler is considered to have handled the call
Type declaration
▸ (): Promise
<string
| boolean
>
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 calledfalse
-> the handler is not considered to have handled the call, and the next handlers will be calledstring
-> the value is shown in the scratchpad, and the handler is considered to have handled the call
Returns
Promise
<string
| boolean
>
Inherited from
Defined in
src/sdk/fmc/components/FmcComponent.ts:41
onSelected
• Optional
onSelected: (scratchpadContents
: string
) => Promise
<string
| boolean
>
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 calledfalse
-> the handler is not considered to have handled the call, and the next handlers will be calledstring
-> the value is shown in the scratchpad, and the handler is considered to have handled the call
Type declaration
▸ (scratchpadContents
): Promise
<string
| boolean
>
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 calledfalse
-> the handler is not considered to have handled the call, and the next handlers will be calledstring
-> the value is shown in the scratchpad, and the handler is considered to have handled the call
Parameters
Name | Type |
---|---|
scratchpadContents | string |
Returns
Promise
<string
| boolean
>
Inherited from
EditableFieldOptions.onSelected
Defined in
src/sdk/fmc/components/FmcComponent.ts:26
prefix
• Optional
prefix: string
Text shown before the value (can be used for start indentation)
Inherited from
Defined in
src/sdk/fmc/components/DisplayField.ts:17
style
• Optional
style: string
| (value
: null
| boolean
) => string
The style to apply to the value. MUST BE WRAPPED IN SQUARE BRACKETS.
Inherited from
Defined in
src/sdk/fmc/components/DisplayField.ts:23
suffix
• Optional
suffix: string
Text shown after the value (can be used for end indentation)
Inherited from
Defined in
src/sdk/fmc/components/DisplayField.ts:20
text
• text: readonly [string
, undefined
| string
]
The text to display for each value of the label. If trueText
is not defined, it defaults to falseText
.
Defined in
src/sdk/fmc/components/ToggleLabel.ts:10