Struct ScrollView 

pub struct ScrollView { /* private fields */ }

ScrollView - A scrollable container.

Provides vertical scrolling with optional follow-end behavior. In constrained layout, the child is measured at unbounded height and clipped to the allocated viewport.

Implementations

impl ScrollView

pub fn new(child: Arc<dyn Component>, options: ScrollViewOptions) -> Self

Create a new ScrollView with the given child.

pub fn simple(child: Arc<dyn Component>) -> Self

Create a simple ScrollView with default options.

pub fn primary(child: Arc<dyn Component>) -> Self

Create a primary ScrollView with follow-end behavior.

pub fn child(&self) -> &Arc<dyn Component>

Get the child component.

pub fn scroll_top(&self) -> usize

Get the current scroll position.

pub fn is_following_end(&self) -> bool

Check if following the end.

pub fn follows_end(&self) -> bool

Whether this view can automatically follow newly appended content.

pub fn viewport_height(&self) -> usize

Get the viewport height.

pub fn content_height(&self) -> usize

Get the content height.

pub fn is_primary(&self) -> bool

Check if this is the primary scroll view.

pub fn is_scrollbar_visible(&self) -> bool

Check if scrollbar is visible.

pub fn get_content_width(&self, width: usize) -> usize

Get the content width (accounting for scrollbar).

pub fn scroll_by(&self, delta: i32) -> i32

Scroll by the given number of lines.

Returns the unused delta if scrolling hit the boundary. This enables scroll chaining for nested scroll views.

pub fn scroll_to(&self, position: usize)

Scroll to a specific position.

pub fn scroll_to_start(&self)

Scroll to the start.

pub fn scroll_to_end(&self)

Scroll to the end.

pub fn update_layout( &self, content_height: usize, viewport_height: usize, request_render: Option<Arc<dyn Fn() + Send + Sync>>, )

Update layout information (called by the layout system).

pub fn render_with_viewport(&self, width: usize, height: usize) -> Vec<String>

Render fresh child content, applying scroll for a fixed viewport.

Normal UI updates use this path so streamed text and mutable tool components are reflected immediately. The result also primes the cache used by subsequent pure scroll frames.

pub fn render_with_cached_content( &self, width: usize, height: usize, ) -> Vec<String>

Apply the viewport to the last rendered child content when possible. A width change automatically falls back to a fresh render.

pub fn scrollbar_style(&self, text: &str) -> String

Get the scrollbar style (can be customized).

Trait Implementations

impl Clone for ScrollView

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ScrollView

fn render(&self, width: usize) -> Vec<String>

Render the component to lines for the given viewport width.

fn invalidate(&self)

Invalidate any cached rendering state. Called when theme changes or when component needs to re-render from scratch.

fn as_any(&self) -> &dyn Any

Downcast to Any for runtime type checking. This enables the layout system to check for LayoutNodeProvider.

fn handle_input(&self, _data: &str) -> bool

Optional handler for keyboard input when component has focus.

fn wants_key_release(&self) -> bool

If true, component receives key release events (Kitty protocol). Default is false - release events are filtered out.

impl LayoutNodeProvider for ScrollView

fn layout_node(&self) -> Option<LayoutNode>

Get the layout node if this component has one.