<!-- cargo-rdme start -->

# Tui-scrollview

[![Crates.io Badge]][Crate] [![License Badge]](#license) [![Docs.rs Badge]][API Docs]<br>
[![Deps.rs Badge]][Dependencies] [![Codecov.io Badge]][Coverage] [![Discord Badge]][Ratatui
Discord]

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

## Installation

```shell
cargo add tui-scrollview
```

## Usage

```rust
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](https://github.com/joshka/tui-widgets/blob/main/tui-scrollview/examples/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](https://vhs.charm.sh/vhs-6PuT3pdwSTp4aTvKrCBx9F.gif)

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

[Crates.io Badge]: https://img.shields.io/crates/v/tui-scrollview?logo=rust&style=for-the-badge
[License Badge]: https://img.shields.io/crates/l/tui-scrollview?style=for-the-badge
[Docs.rs Badge]: https://img.shields.io/docsrs/tui-scrollview?logo=rust&style=for-the-badge
[Deps.rs Badge]:
    https://deps.rs/repo/github/joshka/tui-scrollview/status.svg?style=for-the-badge
[Codecov.io Badge]:
    https://img.shields.io/codecov/c/github/joshka/tui-scrollview?logo=codecov&style=for-the-badge&token=BAQ8SOKEST
[Discord Badge]:
    https://img.shields.io/discord/1070692720437383208?label=ratatui+discord&logo=discord&style=for-the-badge

[Crate]: https://crates.io/crates/tui-scrollview
[API Docs]: https://docs.rs/crate/tui-scrollview/
[Dependencies]: https://deps.rs/repo/github/joshka/tui-scrollview
[Coverage]: https://app.codecov.io/gh/joshka/tui-scrollview
[Ratatui Discord]: https://discord.gg/pMCEU9hNEj

[Ratatui]: https://crates.io/crates/ratatui

<!-- cargo-rdme end -->

## TODO

- [ ] Conditionally show scrollbar
- [x] Implement horizontal scrolling and bar

## License

Copyright (c) Josh McKinney

This project is licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE] or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT] or <http://opensource.org/licenses/MIT>)

at your option.

[LICENSE-APACHE]: /LICENSE-APACHE
[LICENSE-MIT]: /LICENSE-MIT

## 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](/CONTRIBUTING.md).