Skip to main content

Crate tui_treelistview

Crate tui_treelistview 

Source
Expand description

Tree list view widget for ratatui with filtering, marking, and optional key/edit handling.

Feature flags:

  • keymap: crossterm-based key bindings and TreeListViewState::handle_key* helpers.
  • edit: TreeEdit trait and edit-action helpers.
  • serde: serde support for TreeListViewSnapshot.

Modules§

prelude

Structs§

AdaptiveColumns
Adaptive layout that fits columns into the available area.
ColumnDef
Column definition: header label, width constraint, and cell renderer.
ColumnWidth
Width constraints for a column in adaptive layout.
NoFilter
Filter that matches every node.
SimpleColumns
Fixed-width column layout with optional header.
TreeColumnsLayout
Simple container for a label constraint and a fixed set of other constraints.
TreeGlyphs
Glyph set used to render the tree structure and expanders.
TreeLabelPrefix
Label parts: name with an optional prefix (e.g., marker or icon).
TreeListView
Main tree list view widget (table + stateful).
TreeListViewSnapshot
Snapshot of state (selection, expansion, marks).
TreeListViewState
Widget state: expanded nodes, selection, and visibility/mark caches.
TreeListViewStyle
Visual settings for the tree list view widget.
TreeRowContext
Rendering context for a single tree row.
TreeRowNodeState
Node-specific flags used while rendering a row.
TreeRowRenderState
Rendering flags that affect visual presentation.

Enums§

TreeAction
Actions that a user or application can initiate on the tree view.
TreeEvent
Result of handling an action or key event.
TreeFilterConfig
Configuration for filtered rendering.
TreeScrollPolicy
Scroll policy used to keep the selection visible.

Traits§

TreeColumns
Column layout and cell rendering for tree rows.
TreeFilter
Visibility filter for nodes (used to build a reduced list).
TreeLabelProvider
Provides label parts for a node.
TreeLabelRenderer
Renders a node into a Cell for the label column.
TreeModel
Minimal tree contract required by the widget.

Functions§

distribute_widths
Distributes total width across columns respecting min/ideal/max.
tree_label_line
Builds a Line for the tree label, including guides and expanders.
tree_name_cell
Convenience wrapper to build a label Cell from the label Line.

Type Aliases§

ColumnFn
Function pointer type for rendering a single column cell.