Modern Tui TuiListState

Home › Terminal TUI Library › Core Widgets › TuiListState

TuiListState

Holds a list's selected item and scroll position; -1 means nothing is selected.

Syntax

type TuiListState
    as int32 selected   '' -1 = nothing selected
    as int32 offset     '' first visible row
end type

Description

A list's selection and scroll, owned by you. Set selected directly if your application owns its own keymap -- the widget re-clamps and scrolls to it during Render, so the selection cannot walk off the bottom of the window.

Example

#import "std/tui"
using tui

dim as TuiListState st
print st.selected, st.offset      '' 0 0

st.selected = -1                  '' nothing selected is a legal state
print st.selected

'' driving it from your own keymap is fine: Render clamps and follows
st.selected = 9999

See also

TuiBlock	TuiBlock.AddTitle	TuiBorderGlyphs	TuiTitleOf	TuiList	TuiTable
TuiBlock.Inner	TuiBorderSet	TuiTitle	TuiParagraph	TuiRow	TuiTableState

---

Library: Terminal TUI Library
Category: Terminal TUI Library
Documented under: Core Widgets
Working examples: hello.tiko · form.tiko · dashboard.tiko

---

Home · Keyword Index