Skip to main content

Type Alias: UiListDialogParams<T>

UiListDialogParams<T> = object

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

The parameters needed to display a selection list for UiListDialog.

Type Parameters​

Type Parameter
T

Properties​

autoDisableOverscroll?​

optional autoDisableOverscroll: boolean

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

Whether to automatically disable overscrolling when the total height of all the selection list's items does not exceed the list's visible height. Defaults to false.

class?​

optional class: string

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

CSS class(es) to apply to the dialog's root element.

dialogWidth?​

optional dialogWidth: number

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

The width of the dialog, in pixels. If not defined, then the dialog width is controlled by the --ui-list-dialog-width custom CSS variable.

fadeScrollBar?​

optional fadeScrollBar: boolean

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

Whether to fade out the selection list's scroll bar when the total height of all the list's items is less than or equal to the list's visible height. Space is reserved for the scroll bar even when it is faded out. Defaults to true.

highlightSelectedValue?​

optional highlightSelectedValue: boolean

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

Whether to highlight the list item associated with the selected value. Defaults to false.

inputData​

inputData: ListDialogItemDefinition<T>[]

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

An array of list item definitions. Each definition defines one selectable value and how the value is to be displayed in the list.

itemsPerPage?​

optional itemsPerPage: number

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

The number of list items per page to display. Defaults to 5.

listItemHeightPx?​

optional listItemHeightPx: number

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

The height of each list item, in pixels.

listItemSpacingPx?​

optional listItemSpacingPx: number

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

The amount of space between each list item, in pixels.

maxRenderedItemCount?​

optional maxRenderedItemCount: number

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

The maximum number of list items that can be rendered simultaneously. The value will be clamped to be greater than or equal to itemsPerPage * 3. Defaults to 25.

scrollToValue?​

optional scrollToValue: T

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

The value associated with the list item to which to initially scroll. If not defined, then the list will initially scroll to the list item associated with the selected value (if one exists).

selectedValue?​

optional selectedValue: T | Subscribable<T>

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

The currently selected value. The list will initially scroll to and focus the list item associated with the selected value (unless overridden by scrollToValue). The list item associated with the selected value is also optionally highlighted depending on the value of highlightSelectedValue.

showScrollBar?​

optional showScrollBar: boolean | "auto"

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

Whether to show the list's scroll bar. If true, then space is always reserved for the scroll bar, and its visibility depends on the fadeScrollBar option. If false, then no space is reserved for the scroll bar and it is always hidden. If auto, then space is reserved for the scroll bar if and only if the total height of all the list's items exceeds the list's visible height. Defaults to auto.

styleButtonsAsListItems?​

optional styleButtonsAsListItems: boolean

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

Whether to style the rendered buttons in the list as list items instead of touchscreen buttons.