ImGui.ListBox

ListBox(
    label: string | Uint8Array,
    current_item: Int32Array,
    items: readonly string[],
    items_count: number,
    height_in_items?: number,
): boolean
Display a scrolling list of labels for selecting a single item.

Parameters
label
string | Uint8Array
Widget label; interactive widgets also use it for ID generation. A ## suffix can distinguish IDs without displaying the suffix.

current_item
Int32Array
Zero-based selected item index in Int32Array[0], updated when the selection changes. Pass Int32Array storage, not a JS scalar; native access uses the supplied backing memory.

items
readonly string[]
Item labels in display order; items_count must not exceed the array length.

items_count
number
Number of items to process; it must match the available item data.

height_in_items
number = -1
Visible list height measured in items; -1 selects the default height.

Returns
boolean
True when a row is activated, including an already-selected row; this does not guarantee that the selection index changed.
Source & inheritance
- Defined in src/imgui/selection.ts:675

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0