ratatui-toolkit 0.2.6

DEPRECATED: this crate was renamed to `ratkit`. Please migrate to `ratkit`.
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

//! Constructor methods for CustomScrollbar.

use crate::widgets::markdown_widget::extensions::scrollbar::{CustomScrollbar, ScrollbarConfig};
use crate::widgets::markdown_widget::state::scroll_state::ScrollState;

impl<'a> CustomScrollbar<'a> {
    /// Create a new CustomScrollbar with the given scroll state.
    ///
    /// # Arguments
    ///
    /// * `scroll_state` - Reference to the scroll state to track.
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// let scrollbar = CustomScrollbar::new(&scroll_state);
    /// ```
    pub fn new(scroll_state: &'a ScrollState) -> Self {
        Self {
            scroll_state,
            config: ScrollbarConfig::default(),
            show_percentage: false,
        }
    }

    /// Set the scrollbar configuration.
    ///
    /// # Arguments
    ///
    /// * `config` - The configuration to use.
    ///
    /// # Returns
    ///
    /// Self for method chaining.
    pub fn config(mut self, config: ScrollbarConfig) -> Self {
        self.config = config;
        self
    }

    /// Enable or disable the percentage indicator.
    ///
    /// # Arguments
    ///
    /// * `show` - Whether to show the percentage.
    ///
    /// # Returns
    ///
    /// Self for method chaining.
    pub fn show_percentage(mut self, show: bool) -> Self {
        self.show_percentage = show;
        self
    }
}