rat-scrolled 2.0.0

ratatui scroll widget and traits
Documentation 
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

![semver](https://img.shields.io/badge/semver-☑-FFD700)
![stable](https://img.shields.io/badge/stability-stable-8A2BE2)
[![crates.io](https://img.shields.io/crates/v/rat-scrolled.svg)](https://crates.io/crates/rat-scrolled)
[![Documentation](https://docs.rs/rat-scrolled/badge.svg)](https://docs.rs/rat-scrolled)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![License](https://img.shields.io/badge/license-APACHE-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![](https://tokei.rs/b1/github/thscharler/rat-salsa)

This crate is a part of [rat-salsa][refRatSalsa].

For examples see [rat-scrolled GitHub][refGitHubScrolled]

* [Changes](https://github.com/thscharler/rat-salsa/blob/master/rat-scrolled/changes.md)

# Scroll


[Scroll](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.Scroll.html) adds
support for widgets that want to scroll their content.

Scroll works analogous to Block, it can be set on the widget
struct where it is supported. The widget can decide which
scrolling it can do, horizontal vertical or both.

# Adding scroll to a widget


- Add [Scroll](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.Scroll.html)
  to the widget struct.
- Use [ScrollArea](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.ScrollArea.html)
  for the layout and rendering of the combination of
  Block+Scroll+Scroll your widget supports.
- Add [ScrollState](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.ScrollState.html)
  to the widget state struct.
- Use a [ScrollAreaState](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.ScrollAreaState.html)
  for event-handling.

[Examples](https://github.com/thscharler/rat-salsa/tree/master/rat-scrolled/examples)

# For what?


This is for widgets that handle their scrolling internally.
They use [ScrollState::offset](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.ScrollState.html)
to manage what they have to render. And they
set [ScrollState::page_len](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.ScrollState.html)
and [ScrollState::max_offset](https://docs.rs/rat-scrolled/latest/rat_scrolled/struct.ScrollState.html) to get a correct
scrollbar displayed.

Widgets that don't want to do this can be rendered using
[View](https://docs.rs/rat-widget/latest/rat_widget/view/index.html) or
[Clipper](https://docs.rs/rat-widget/latest/rat_widget/clipper/index.html).

[refRatSalsa]: https://docs.rs/rat-salsa/latest/rat_salsa/

[refGitHubScrolled]: https://github.com/thscharler/rat-salsa/blob/master/rat-scrolled/examples