# `ExRatatui.Widgets.WidgetList`
[🔗](https://github.com/mcass19/ex_ratatui/blob/v0.7.1/lib/ex_ratatui/widgets/widget_list.ex#L1)

A vertical list of heterogeneous widgets with optional selection and scrolling.

Each item is a `{widget, height}` tuple where `widget` is any ExRatatui widget
and `height` is the number of rows that item occupies. Items can have different
heights, making this ideal for chat message histories.

`scroll_offset` is a **row offset** from the top of the content. To scroll to
a specific widget, sum the heights of all preceding items. Items partially above
the viewport are clipped at the row level.

## Examples

    iex> %ExRatatui.Widgets.WidgetList{}
    %ExRatatui.Widgets.WidgetList{
      items: [],
      selected: nil,
      highlight_style: %ExRatatui.Style{},
      scroll_offset: 0,
      style: %ExRatatui.Style{},
      block: nil
    }

    iex> alias ExRatatui.Widgets.{WidgetList, Paragraph, Block}
    iex> %WidgetList{
    ...>   items: [
    ...>     {%Paragraph{text: "First message"}, 1},
    ...>     {%Paragraph{text: "Second message"}, 1}
    ...>   ],
    ...>   selected: 0,
    ...>   block: %Block{title: "Chat", borders: [:all]}
    ...> }
    %ExRatatui.Widgets.WidgetList{
      items: [
        {%ExRatatui.Widgets.Paragraph{text: "First message"}, 1},
        {%ExRatatui.Widgets.Paragraph{text: "Second message"}, 1}
      ],
      selected: 0,
      highlight_style: %ExRatatui.Style{},
      scroll_offset: 0,
      style: %ExRatatui.Style{},
      block: %ExRatatui.Widgets.Block{title: "Chat", borders: [:all]}
    }

# `t`

```elixir
@type t() :: %ExRatatui.Widgets.WidgetList{
  block: ExRatatui.Widgets.Block.t() | nil,
  highlight_style: ExRatatui.Style.t(),
  items: [{ExRatatui.widget(), non_neg_integer()}],
  scroll_offset: non_neg_integer(),
  selected: non_neg_integer() | nil,
  style: ExRatatui.Style.t()
}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*