25 releases

0.5.1 Nov 24, 2024
0.4.1 Oct 20, 2024
0.3.11 Jul 25, 2024
0.3.3 Mar 28, 2024

#225 in Command-line interface

Download history 44/week @ 2024-08-21 249/week @ 2024-08-28 123/week @ 2024-09-04 284/week @ 2024-09-11 143/week @ 2024-09-18 382/week @ 2024-09-25 207/week @ 2024-10-02 305/week @ 2024-10-09 417/week @ 2024-10-16 572/week @ 2024-10-23 219/week @ 2024-10-30 162/week @ 2024-11-06 367/week @ 2024-11-13 441/week @ 2024-11-20 509/week @ 2024-11-27 490/week @ 2024-12-04

1,843 downloads per month
Used in 14 crates (13 directly)

MIT/Apache

40KB
593 lines

Tui-scrollview

Crates.io Badge License Badge Docs.rs Badge
Deps.rs Badge Codecov.io Badge Discord Badge

tui-scrollview is a library for creating scrollable views in Ratatui.

Installation

cargo add tui-scrollview

Usage

use std::iter;
use tui_scrollview::{ScrollView, ScrollViewState};
use ratatui::{layout::Size, prelude::*, widgets::*};

struct MyScrollableWidget;

impl StatefulWidget for MyScrollableWidget {
    type State = ScrollViewState;

    fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
        // 100 lines of text
        let line_numbers = (1..=100).map(|i| format!("{:>3} ", i)).collect::<String>();
        let content =
            iter::repeat("Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n")
                .take(100)
                .collect::<String>();

        let content_size = Size::new(100, 30);
        let mut scroll_view = ScrollView::new(content_size);

        // the layout doesn't have to be hardcoded like this, this is just an example
        scroll_view.render_widget(Paragraph::new(line_numbers), Rect::new(0, 0, 5, 100));
        scroll_view.render_widget(Paragraph::new(content), Rect::new(5, 0, 95, 100));

        scroll_view.render(buf.area, buf, state);
    }
}

Full Example

A full example can be found in the [examples] directory. scrollview.rs

This example shows a scrollable view with two paragraphs of text, one for the line numbers and one for the text. On top of this a Gauge widget is rendered to show that this can be used in combination with any other widget.

Demo

(Note: a github bug stops the example gif above being displayed, but you can view it at: https://vhs.charm.sh/vhs-6PuT3pdwSTp4aTvKrCBx9F.gif)

TODO

  • Conditionally show scrollbar
  • Implement horizontal scrolling and bar

License

Copyright (c) Josh McKinney

This project is licensed under either of:

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING.md.

Dependencies

~9MB
~145K SLoC