class RatatuiRuby::TableState
Mutable state object for Table widgets.
When using {Frame#render_stateful_widget}, the State object is the *single source of truth* for selection and scroll offset. Widget properties (selected_row, selected_column, offset) are ignored in stateful mode.
Example
@table_state = RatatuiRuby::TableState.new @table_state.select(1) # Select second row @table_state.select_column(0) # Select first column RatatuiRuby.draw do |frame| table = RatatuiRuby::Widgets::Table.new(rows: [...], widths: [...]) frame.render_stateful_widget(table, frame.area, @table_state) end
Public Class Methods
Source
# File lib/ratatui_ruby/table_state.rb, line 142
Creates a new TableState with both row and column selected.
- cell
-
[row, column]array, ornil.
(Native method implemented in Rust)
Public Instance Methods
Source
# File lib/ratatui_ruby/table_state.rb, line 37
Creates a new TableState with optional initial row selection.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 77
Returns the current scroll offset.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 85
Scrolls down by n rows.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 93
Scrolls up by n rows.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 45
Sets the selected row index. Pass nil to deselect.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 61
Sets the selected column index. Pass nil to deselect.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 126
Selects column 0.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 134
Selects the last column. The index is clamped during rendering.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 110
Selects the next column, or column 0 if none selected.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 118
Selects the previous column. Saturates at 0.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 53
Returns the currently selected row index.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 101
Returns the currently selected cell as [row, column]. Returns nil if either row or column is not selected.
(Native method implemented in Rust)
Source
# File lib/ratatui_ruby/table_state.rb, line 69
Returns the currently selected column index.
(Native method implemented in Rust)