ratatui/widgets/table/table_state.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
/// State of a [`Table`] widget
///
/// This state can be used to scroll through the rows and select one of them. When the table is
/// rendered as a stateful widget, the selected row, column and cell will be highlighted and the
/// table will be shifted to ensure that the selected row is visible. This will modify the
/// [`TableState`] object passed to the [`Frame::render_stateful_widget`] method.
///
/// The state consists of two fields:
/// - [`offset`]: the index of the first row to be displayed
/// - [`selected`]: the index of the selected row, which can be `None` if no row is selected
/// - [`selected_column`]: the index of the selected column, which can be `None` if no column is
/// selected
///
/// [`offset`]: TableState::offset()
/// [`selected`]: TableState::selected()
/// [`selected_column`]: TableState::selected_column()
///
/// See the `table` example and the `recipe` and `traceroute` tabs in the demo2 example in the
/// [Examples] directory for a more in depth example of the various configuration options and for
/// how to handle state.
///
/// [Examples]: https://github.com/ratatui/ratatui/blob/master/examples/README.md
///
/// # Example
///
/// ```rust
/// use ratatui::{
/// layout::{Constraint, Rect},
/// widgets::{Row, Table, TableState},
/// Frame,
/// };
///
/// # fn ui(frame: &mut Frame) {
/// # let area = Rect::default();
/// let rows = [Row::new(vec!["Cell1", "Cell2"])];
/// let widths = [Constraint::Length(5), Constraint::Length(5)];
/// let table = Table::new(rows, widths).widths(widths);
///
/// // Note: TableState should be stored in your application state (not constructed in your render
/// // method) so that the selected row is preserved across renders
/// let mut table_state = TableState::default();
/// *table_state.offset_mut() = 1; // display the second row and onwards
/// table_state.select(Some(3)); // select the forth row (0-indexed)
/// table_state.select_column(Some(2)); // select the third column (0-indexed)
///
/// frame.render_stateful_widget(table, area, &mut table_state);
/// # }
/// ```
///
/// Note that if [`Table::widths`] is not called before rendering, the rendered columns will have
/// equal width.
///
/// [`Table`]: crate::widgets::Table
/// [`Table::widths`]: crate::widgets::Table::widths
/// [`Frame::render_stateful_widget`]: crate::Frame::render_stateful_widget
#[derive(Debug, Default, Clone, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TableState {
pub(crate) offset: usize,
pub(crate) selected: Option<usize>,
pub(crate) selected_column: Option<usize>,
}
impl TableState {
/// Creates a new [`TableState`]
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let state = TableState::new();
/// ```
pub const fn new() -> Self {
Self {
offset: 0,
selected: None,
selected_column: None,
}
}
/// Sets the index of the first row to be displayed
///
/// This is a fluent setter method which must be chained or used as it consumes self
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let state = TableState::new().with_offset(1);
/// ```
#[must_use = "method moves the value of self and returns the modified value"]
pub const fn with_offset(mut self, offset: usize) -> Self {
self.offset = offset;
self
}
/// Sets the index of the selected row
///
/// This is a fluent setter method which must be chained or used as it consumes self
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let state = TableState::new().with_selected(Some(1));
/// ```
#[must_use = "method moves the value of self and returns the modified value"]
pub fn with_selected<T>(mut self, selected: T) -> Self
where
T: Into<Option<usize>>,
{
self.selected = selected.into();
self
}
/// Sets the index of the selected column
///
/// This is a fluent setter method which must be chained or used as it consumes self
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let state = TableState::new().with_selected_column(Some(1));
/// ```
#[must_use = "method moves the value of self and returns the modified value"]
pub fn with_selected_column<T>(mut self, selected: T) -> Self
where
T: Into<Option<usize>>,
{
self.selected_column = selected.into();
self
}
/// Sets the indexes of the selected cell
///
/// This is a fluent setter method which must be chained or used as it consumes self
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let state = TableState::new().with_selected_cell(Some((1, 5)));
/// ```
#[must_use = "method moves the value of self and returns the modified value"]
pub fn with_selected_cell<T>(mut self, selected: T) -> Self
where
T: Into<Option<(usize, usize)>>,
{
if let Some((r, c)) = selected.into() {
self.selected = Some(r);
self.selected_column = Some(c);
} else {
self.selected = None;
self.selected_column = None;
}
self
}
/// Index of the first row to be displayed
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let state = TableState::new();
/// assert_eq!(state.offset(), 0);
/// ```
pub const fn offset(&self) -> usize {
self.offset
}
/// Mutable reference to the index of the first row to be displayed
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// *state.offset_mut() = 1;
/// ```
pub fn offset_mut(&mut self) -> &mut usize {
&mut self.offset
}
/// Index of the selected row
///
/// Returns `None` if no row is selected
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let state = TableState::new();
/// assert_eq!(state.selected(), None);
/// ```
pub const fn selected(&self) -> Option<usize> {
self.selected
}
/// Index of the selected column
///
/// Returns `None` if no column is selected
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let state = TableState::new();
/// assert_eq!(state.selected_column(), None);
/// ```
pub const fn selected_column(&self) -> Option<usize> {
self.selected_column
}
/// Indexes of the selected cell
///
/// Returns `None` if no cell is selected
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let state = TableState::new();
/// assert_eq!(state.selected_cell(), None);
/// ```
pub const fn selected_cell(&self) -> Option<(usize, usize)> {
if let (Some(r), Some(c)) = (self.selected, self.selected_column) {
return Some((r, c));
}
None
}
/// Mutable reference to the index of the selected row
///
/// Returns `None` if no row is selected
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// *state.selected_mut() = Some(1);
/// ```
pub fn selected_mut(&mut self) -> &mut Option<usize> {
&mut self.selected
}
/// Mutable reference to the index of the selected column
///
/// Returns `None` if no column is selected
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// *state.selected_column_mut() = Some(1);
/// ```
pub fn selected_column_mut(&mut self) -> &mut Option<usize> {
&mut self.selected_column
}
/// Sets the index of the selected row
///
/// Set to `None` if no row is selected. This will also reset the offset to `0`.
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// state.select(Some(1));
/// ```
pub fn select(&mut self, index: Option<usize>) {
self.selected = index;
if index.is_none() {
self.offset = 0;
}
}
/// Sets the index of the selected column
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.select_column(Some(1));
/// ```
pub fn select_column(&mut self, index: Option<usize>) {
self.selected_column = index;
}
/// Sets the indexes of the selected cell
///
/// Set to `None` if no cell is selected. This will also reset the row offset to `0`.
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.select_cell(Some((1, 5)));
/// ```
pub fn select_cell(&mut self, indexes: Option<(usize, usize)>) {
if let Some((r, c)) = indexes {
self.selected = Some(r);
self.selected_column = Some(c);
} else {
self.offset = 0;
self.selected = None;
self.selected_column = None;
}
}
/// Selects the next row or the first one if no row is selected
///
/// Note: until the table is rendered, the number of rows is not known, so the index is set to
/// `0` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// state.select_next();
/// ```
pub fn select_next(&mut self) {
let next = self.selected.map_or(0, |i| i.saturating_add(1));
self.select(Some(next));
}
/// Selects the next column or the first one if no column is selected
///
/// Note: until the table is rendered, the number of columns is not known, so the index is set
/// to `0` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.select_next_column();
/// ```
pub fn select_next_column(&mut self) {
let next = self.selected_column.map_or(0, |i| i.saturating_add(1));
self.select_column(Some(next));
}
/// Selects the previous row or the last one if no item is selected
///
/// Note: until the table is rendered, the number of rows is not known, so the index is set to
/// `usize::MAX` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// state.select_previous();
/// ```
pub fn select_previous(&mut self) {
let previous = self.selected.map_or(usize::MAX, |i| i.saturating_sub(1));
self.select(Some(previous));
}
/// Selects the previous column or the last one if no column is selected
///
/// Note: until the table is rendered, the number of columns is not known, so the index is set
/// to `usize::MAX` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.select_previous_column();
/// ```
pub fn select_previous_column(&mut self) {
let previous = self
.selected_column
.map_or(usize::MAX, |i| i.saturating_sub(1));
self.select_column(Some(previous));
}
/// Selects the first row
///
/// Note: until the table is rendered, the number of rows is not known, so the index is set to
/// `0` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// state.select_first();
/// ```
pub fn select_first(&mut self) {
self.select(Some(0));
}
/// Selects the first column
///
/// Note: until the table is rendered, the number of columns is not known, so the index is set
/// to `0` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.select_first_column();
/// ```
pub fn select_first_column(&mut self) {
self.select_column(Some(0));
}
/// Selects the last row
///
/// Note: until the table is rendered, the number of rows is not known, so the index is set to
/// `usize::MAX` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// state.select_last();
/// ```
pub fn select_last(&mut self) {
self.select(Some(usize::MAX));
}
/// Selects the last column
///
/// Note: until the table is rendered, the number of columns is not known, so the index is set
/// to `usize::MAX` and will be corrected when the table is rendered
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.select_last();
/// ```
pub fn select_last_column(&mut self) {
self.select_column(Some(usize::MAX));
}
/// Scrolls down by a specified `amount` in the table.
///
/// This method updates the selected index by moving it down by the given `amount`.
/// If the `amount` causes the index to go out of bounds (i.e., if the index is greater than
/// the number of rows in the table), the last row in the table will be selected.
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// state.scroll_down_by(4);
/// ```
pub fn scroll_down_by(&mut self, amount: u16) {
let selected = self.selected.unwrap_or_default();
self.select(Some(selected.saturating_add(amount as usize)));
}
/// Scrolls up by a specified `amount` in the table.
///
/// This method updates the selected index by moving it up by the given `amount`.
/// If the `amount` causes the index to go out of bounds (i.e., less than zero),
/// the first row in the table will be selected.
///
/// # Examples
///
/// ```rust
/// use ratatui::widgets::TableState;
///
/// let mut state = TableState::default();
/// state.scroll_up_by(4);
/// ```
pub fn scroll_up_by(&mut self, amount: u16) {
let selected = self.selected.unwrap_or_default();
self.select(Some(selected.saturating_sub(amount as usize)));
}
/// Scrolls right by a specified `amount` in the table.
///
/// This method updates the selected index by moving it right by the given `amount`.
/// If the `amount` causes the index to go out of bounds (i.e., if the index is greater than
/// the number of columns in the table), the last column in the table will be selected.
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.scroll_right_by(4);
/// ```
pub fn scroll_right_by(&mut self, amount: u16) {
let selected = self.selected_column.unwrap_or_default();
self.select_column(Some(selected.saturating_add(amount as usize)));
}
/// Scrolls left by a specified `amount` in the table.
///
/// This method updates the selected index by moving it left by the given `amount`.
/// If the `amount` causes the index to go out of bounds (i.e., less than zero),
/// the first item in the table will be selected.
///
/// # Examples
///
/// ```rust
/// # use ratatui::widgets::{TableState};
/// let mut state = TableState::default();
/// state.scroll_left_by(4);
/// ```
pub fn scroll_left_by(&mut self, amount: u16) {
let selected = self.selected_column.unwrap_or_default();
self.select_column(Some(selected.saturating_sub(amount as usize)));
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn new() {
let state = TableState::new();
assert_eq!(state.offset, 0);
assert_eq!(state.selected, None);
assert_eq!(state.selected_column, None);
}
#[test]
fn with_offset() {
let state = TableState::new().with_offset(1);
assert_eq!(state.offset, 1);
}
#[test]
fn with_selected() {
let state = TableState::new().with_selected(Some(1));
assert_eq!(state.selected, Some(1));
}
#[test]
fn with_selected_column() {
let state = TableState::new().with_selected_column(Some(1));
assert_eq!(state.selected_column, Some(1));
}
#[test]
fn with_selected_cell_none() {
let state = TableState::new().with_selected_cell(None);
assert_eq!(state.selected, None);
assert_eq!(state.selected_column, None);
}
#[test]
fn offset() {
let state = TableState::new();
assert_eq!(state.offset(), 0);
}
#[test]
fn offset_mut() {
let mut state = TableState::new();
*state.offset_mut() = 1;
assert_eq!(state.offset, 1);
}
#[test]
fn selected() {
let state = TableState::new();
assert_eq!(state.selected(), None);
}
#[test]
fn selected_column() {
let state = TableState::new();
assert_eq!(state.selected_column(), None);
}
#[test]
fn selected_cell() {
let state = TableState::new();
assert_eq!(state.selected_cell(), None);
}
#[test]
fn selected_mut() {
let mut state = TableState::new();
*state.selected_mut() = Some(1);
assert_eq!(state.selected, Some(1));
}
#[test]
fn selected_column_mut() {
let mut state = TableState::new();
*state.selected_column_mut() = Some(1);
assert_eq!(state.selected_column, Some(1));
}
#[test]
fn select() {
let mut state = TableState::new();
state.select(Some(1));
assert_eq!(state.selected, Some(1));
}
#[test]
fn select_none() {
let mut state = TableState::new().with_selected(Some(1));
state.select(None);
assert_eq!(state.selected, None);
}
#[test]
fn select_column() {
let mut state = TableState::new();
state.select_column(Some(1));
assert_eq!(state.selected_column, Some(1));
}
#[test]
fn select_column_none() {
let mut state = TableState::new().with_selected_column(Some(1));
state.select_column(None);
assert_eq!(state.selected_column, None);
}
#[test]
fn select_cell() {
let mut state = TableState::new();
state.select_cell(Some((1, 5)));
assert_eq!(state.selected_cell(), Some((1, 5)));
}
#[test]
fn select_cell_none() {
let mut state = TableState::new().with_selected_cell(Some((1, 5)));
state.select_cell(None);
assert_eq!(state.selected, None);
assert_eq!(state.selected_column, None);
assert_eq!(state.selected_cell(), None);
}
#[test]
fn test_table_state_navigation() {
let mut state = TableState::default();
state.select_first();
assert_eq!(state.selected, Some(0));
state.select_previous(); // should not go below 0
assert_eq!(state.selected, Some(0));
state.select_next();
assert_eq!(state.selected, Some(1));
state.select_previous();
assert_eq!(state.selected, Some(0));
state.select_last();
assert_eq!(state.selected, Some(usize::MAX));
state.select_next(); // should not go above usize::MAX
assert_eq!(state.selected, Some(usize::MAX));
state.select_previous();
assert_eq!(state.selected, Some(usize::MAX - 1));
state.select_next();
assert_eq!(state.selected, Some(usize::MAX));
let mut state = TableState::default();
state.select_next();
assert_eq!(state.selected, Some(0));
let mut state = TableState::default();
state.select_previous();
assert_eq!(state.selected, Some(usize::MAX));
let mut state = TableState::default();
state.select(Some(2));
state.scroll_down_by(4);
assert_eq!(state.selected, Some(6));
let mut state = TableState::default();
state.scroll_up_by(3);
assert_eq!(state.selected, Some(0));
state.select(Some(6));
state.scroll_up_by(4);
assert_eq!(state.selected, Some(2));
state.scroll_up_by(4);
assert_eq!(state.selected, Some(0));
let mut state = TableState::default();
state.select_first_column();
assert_eq!(state.selected_column, Some(0));
state.select_previous_column();
assert_eq!(state.selected_column, Some(0));
state.select_next_column();
assert_eq!(state.selected_column, Some(1));
state.select_previous_column();
assert_eq!(state.selected_column, Some(0));
state.select_last_column();
assert_eq!(state.selected_column, Some(usize::MAX));
state.select_previous_column();
assert_eq!(state.selected_column, Some(usize::MAX - 1));
let mut state = TableState::default().with_selected_column(Some(12));
state.scroll_right_by(4);
assert_eq!(state.selected_column, Some(16));
state.scroll_left_by(20);
assert_eq!(state.selected_column, Some(0));
state.scroll_right_by(100);
assert_eq!(state.selected_column, Some(100));
state.scroll_left_by(20);
assert_eq!(state.selected_column, Some(80));
}
}