Skip to main content

Type Alias: ListDialogItemDefinition<T>

ListDialogItemDefinition<T> = object

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/UiListDialog.tsx:87

A definition for a selection list item in a UiListDialog.

Type Parameters​

Type Parameter
T

Properties​

isEnabled?​

optional isEnabled: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/UiListDialog.tsx:102

Whether the list item button is enabled or not. Defaults to true.

labelRenderer()​

labelRenderer: () => string | VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/UiListDialog.tsx:89

A function which renders the list item button's label.

Returns​

string | VNode

onDestroy()?​

optional onDestroy: () => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/UiListDialog.tsx:105

A callback function to execute when the list item is destroyed.

Returns​

void

onPressed()?​

optional onPressed: (value) => boolean | Promise<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/UiListDialog.tsx:99

A callback function to execute when a list item button is pressed. The function should accept the value of the item as a parameter and return whether the pending request should be fulfilled with the value. If not defined, pressing the button will always fulfill the pending request with the value of the list item.

Parameters​

ParameterType
valueT

Returns​

boolean | Promise<boolean>

value​

value: T

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/UiListDialog.tsx:92

The value to return out of the dialog when the list item is selected.