etui - v1.0.0

etui/widgets/list

Types

ListState

</>

Scroll and selection state for a list. Kept external so state persists across renders.

pub type ListState {
  ListState(selected: Int, offset: Int)
}

Constructors 

  • ListState(selected: Int, offset: Int)

ListWidget

</>

Scrollable list of styled items with selection highlight.

pub type ListWidget {
  ListWidget(
    items: List(span.Line),
    fg: style.Color,
    bg: style.Color,
    highlight_style: style.Style,
    blink_period: Int,
  )
}

Constructors

Values

clamp_state

</> 
pub fn clamp_state(
  state: ListState,
  item_count: Int,
) -> ListState

Clamp selected to [0, item_count - 1]. Call after replacing the item list to avoid a stale selection index.

effective_offset

</> 
pub fn effective_offset(state: ListState, height: Int) -> Int

list_new

</> 
pub fn list_new(items: List(String)) -> ListWidget

New list from plain strings. Default colors, reverse-video selection.

list_new_styled

</> 
pub fn list_new_styled(items: List(span.Line)) -> ListWidget

New list from styled span.Line items.

list.list_new_styled([
  span.line_new([span.span_styled("ERROR", style.bold_style()), span.span_plain(" file")]),
  span.line_plain("normal item"),
])

render

</> 
pub fn render(
  buf: buffer.Buffer,
  area: geometry.Rect,
  l: ListWidget,
) -> buffer.Buffer

render_animated

</> 
pub fn render_animated(
  buf: buffer.Buffer,
  area: geometry.Rect,
  l: ListWidget,
  state: ListState,
  frame: Int,
) -> buffer.Buffer

render_stateful

</> 
pub fn render_stateful(
  buf: buffer.Buffer,
  area: geometry.Rect,
  l: ListWidget,
  state: ListState,
) -> buffer.Buffer

select

</> 
pub fn select(state: ListState, idx: Int) -> ListState

select_next

</> 
pub fn select_next(
  state: ListState,
  item_count: Int,
) -> ListState

select_prev

</> 
pub fn select_prev(state: ListState) -> ListState

state_new

</> 
pub fn state_new() -> ListState
</> 
pub fn with_blink(l: ListWidget, period: Int) -> ListWidget

Blink period in frames. 0 = steady (no blink). Use with render_animated.

with_colors

</> 
pub fn with_colors(
  l: ListWidget,
  fg: style.Color,
  bg: style.Color,
) -> ListWidget

with_highlight_style

</> 
pub fn with_highlight_style(
  l: ListWidget,
  s: style.Style,
) -> ListWidget

with_style

</> 
pub fn with_style(l: ListWidget, s: style.Style) -> ListWidget
✨ Search Document