Interface: DisplayFieldOptions<T>

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

Display field options

Extends

• FmcComponentOptions

Extended by

• EditableFieldOptions

Type Parameters

Type Parameter
T

Properties

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

FmcComponentOptions.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

FmcComponentOptions.disabled

---

formatter

formatter: FmcComponentFormatter<T>

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

Formatter object

---

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

FmcComponentOptions.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

FmcComponentOptions.onSelected

---

prefix?

optional prefix: string

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

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

---

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.

---

suffix?

optional suffix: string

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

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