Struct Viewport 

pub struct Viewport {
    pub width: usize,
    pub height: usize,
    pub key_map: KeyMap,
    pub mouse_wheel_enabled: bool,
    pub mouse_wheel_delta: usize,
    pub style: Style,
    /* private fields */
}

Viewport model for scrollable content.

Fields

width: usize

Width of the viewport.

height: usize

Height of the viewport.

key_map: KeyMap

Key bindings for navigation.

mouse_wheel_enabled: bool

Whether mouse wheel scrolling is enabled.

mouse_wheel_delta: usize

Number of lines to scroll per mouse wheel tick.

style: Style

Style for rendering the viewport.

Implementations

impl Viewport

pub fn new(width: usize, height: usize) -> Self

Creates a new viewport with the given dimensions.

pub fn set_content(&mut self, content: &str)

Sets the content of the viewport.

pub fn y_offset(&self) -> usize

Returns the vertical scroll offset.

pub fn set_y_offset(&mut self, n: usize)

Sets the vertical scroll offset.

pub fn x_offset(&self) -> usize

Returns the horizontal scroll offset.

pub fn set_x_offset(&mut self, n: usize)

Sets the horizontal scroll offset.

pub fn set_horizontal_step(&mut self, n: usize)

Sets the horizontal scroll step size.

pub fn at_top(&self) -> bool

Returns whether the viewport is at the top.

pub fn at_bottom(&self) -> bool

Returns whether the viewport is at the bottom.

pub fn past_bottom(&self) -> bool

Returns whether the viewport is past the bottom.

pub fn scroll_percent(&self) -> f64

Returns the scroll percentage (0.0 to 1.0).

pub fn horizontal_scroll_percent(&self) -> f64

Returns the horizontal scroll percentage (0.0 to 1.0).

pub fn total_line_count(&self) -> usize

Returns the total number of lines.

pub fn visible_line_count(&self) -> usize

Returns the number of visible lines.

pub fn scroll_down(&mut self, n: usize)

Scrolls down by the given number of lines.

pub fn scroll_up(&mut self, n: usize)

Scrolls up by the given number of lines.

pub fn scroll_left(&mut self, n: usize)

Scrolls left by the given number of columns.

pub fn scroll_right(&mut self, n: usize)

Scrolls right by the given number of columns.

pub fn page_down(&mut self)

Moves down one page.

pub fn page_up(&mut self)

Moves up one page.

pub fn half_page_down(&mut self)

Moves down half a page.

pub fn half_page_up(&mut self)

Moves up half a page.

pub fn goto_top(&mut self)

Goes to the top.

pub fn goto_bottom(&mut self)

Goes to the bottom.

pub fn update(&mut self, msg: &Message)

Updates the viewport based on key/mouse input.

pub fn view(&self) -> String

Renders the viewport content.

Trait Implementations

impl Clone for Viewport

fn clone(&self) -> Viewport

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Viewport

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

Formats the value using the given formatter.

impl Model for Viewport

Implement the Model trait for standalone bubbletea usage.

fn init(&self) -> Option<Cmd>

Initialize the model and return an optional startup command.

fn update(&mut self, msg: Message) -> Option<Cmd>

Process a message and return a new command.

fn view(&self) -> String

Render the model as a string for display.