Struct CustomScrollbar 

pub struct CustomScrollbar<'a> { /* private fields */ }

Available on crate feature markdown-preview only.

Custom scrollbar widget for markdown navigation.

Shows scroll position using block characters with accurate tracking. Supports click-to-scroll and drag interactions.

This is a UI-only widget that receives &ScrollState for state access. State mutations happen through ScrollState methods, not here.

Example

use ratatui_toolkit::markdown_widget::state::scroll::ScrollState;

let scroll_state = ScrollState::default();
let scrollbar = CustomScrollbar::new(&scroll_state)
    .config(ScrollbarConfig::default())
    .show_percentage(true);

Implementations

impl<'a> CustomScrollbar<'a>

Constructor methods for CustomScrollbar.

pub fn new(scroll_state: &'a ScrollState) -> CustomScrollbar<'a>

Create a new CustomScrollbar with the given scroll state.

Arguments

• scroll_state - Reference to the scroll state to track.

Example

let scrollbar = CustomScrollbar::new(&scroll_state);

pub fn config(self, config: ScrollbarConfig) -> CustomScrollbar<'a>

Set the scrollbar configuration.

Arguments

• config - The configuration to use.

Returns

Self for method chaining.

pub fn show_percentage(self, show: bool) -> CustomScrollbar<'a>

Enable or disable the percentage indicator.

Arguments

• show - Whether to show the percentage.

Returns

Self for method chaining.

impl<'a> CustomScrollbar<'a>

This impl block contains no items.

Render the scrollbar thumb (scrollable indicator).

impl<'a> CustomScrollbar<'a>

This impl block contains no items.

Render the scrollbar track (background).

Trait Implementations

impl<'a> Debug for CustomScrollbar<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Widget for CustomScrollbar<'a>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.