etui - v2.0.0

etui/widgets/multi_select

Types

MultiSelectState

</>

selected is kept sorted ascending and contains unique indices.

pub type MultiSelectState {
  MultiSelectState(cursor: Int, selected: List(Int), offset: Int)
}

Constructors 

  • MultiSelectState(cursor: Int, selected: List(Int), offset: Int)

MultiSelectWidget

</> 
pub type MultiSelectWidget {
  MultiSelectWidget(
    items: List(String),
    cursor_style: style.Style,
    selected_style: style.Style,
    checked_mark: String,
    unchecked_mark: String,
    cursor_mark: String,
    max: Int,
    fg: style.Color,
    bg: style.Color,
  )
}

Constructors

Values

clear_selection

</> 
pub fn clear_selection(
  state: MultiSelectState,
) -> MultiSelectState

Drop every check; the cursor stays where it is.

effective_offset

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

Effective scroll offset for a viewport of height rows.

is_selected

</> 
pub fn is_selected(state: MultiSelectState, idx: Int) -> Bool

Is the item at idx checked?

multi_select_new

</> 
pub fn multi_select_new(items: List(String)) -> MultiSelectWidget

A checkbox list with reverse-video cursor and [x] marks.

render

</> 
pub fn render(
  buf: buffer.Buffer,
  area: geometry.Rect,
  w: MultiSelectWidget,
  state: MultiSelectState,
) -> buffer.Buffer

Render the visible window of items, scrolling to keep the cursor in view.

select_next

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

Move the cursor down, stopping at the last item.

select_prev

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

Move the cursor up, stopping at the first item.

selected_indices

</> 
pub fn selected_indices(state: MultiSelectState) -> List(Int)

Indices of the checked items, sorted ascending.

selected_values

</> 
pub fn selected_values(
  items: List(String),
  state: MultiSelectState,
) -> List(String)

Pull the selected item strings in original order.

state_new

</> 
pub fn state_new() -> MultiSelectState

Cursor at the first item, nothing checked.

toggle

</> 
pub fn toggle(
  state: MultiSelectState,
  max: Int,
) -> MultiSelectState

Toggle the cursor item. Respects max from the widget config.

with_colors

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

Colors of plain unselected rows.

with_cursor_mark

</> 
pub fn with_cursor_mark(
  w: MultiSelectWidget,
  m: String,
) -> MultiSelectWidget

Marker drawn left of the cursor row; other rows get matching blanks.

with_cursor_style

</> 
pub fn with_cursor_style(
  w: MultiSelectWidget,
  s: style.Style,
) -> MultiSelectWidget

Style of the row under the cursor.

with_marks

</> 
pub fn with_marks(
  w: MultiSelectWidget,
  checked: String,
  unchecked: String,
) -> MultiSelectWidget

Replace the [x] / [ ] marks (e.g. "✓ " / " ").

with_max

</> 
pub fn with_max(
  w: MultiSelectWidget,
  m: Int,
) -> MultiSelectWidget

Cap the number of selected items. 0 = unlimited.

with_selected_style

</> 
pub fn with_selected_style(
  w: MultiSelectWidget,
  s: style.Style,
) -> MultiSelectWidget

Style applied to checked rows that are not under the cursor.

✨ Search Document