Struct ScrollArea 

pub struct ScrollArea { /* private fields */ }

A configurable scroll area builder

Implementations

impl ScrollArea

pub fn new() -> Self

Create a new scroll area (vertical by default)

pub fn vertical() -> Self

Create a vertical scroll area

pub fn horizontal() -> Self

Create a horizontal scroll area

pub fn both() -> Self

Create a scroll area that scrolls both directions

pub fn id_salt(self, id: impl Hash) -> Self

Set a custom ID to avoid ID clashes

pub fn max_height(self, max_height: f32) -> Self

Set maximum height (pixels)

pub fn max_width(self, max_width: f32) -> Self

Set maximum width (pixels)

pub fn min_scrolled_height(self, height: f32) -> Self

Set minimum scrolled height

pub fn min_scrolled_width(self, width: f32) -> Self

Set minimum scrolled width

pub fn auto_shrink(self, auto_shrink: [bool; 2]) -> Self

Set auto-shrink behavior [horizontal, vertical]

If true, the scroll area will shrink to fit its content. Default is [true, true].

pub fn no_shrink(self) -> Self

Disable auto-shrink (expand to fill available space)

pub fn scroll_bar_visibility(self, visibility: ScrollBarVisibility) -> Self

Set scroll bar visibility

pub fn always_show_scroll(self) -> Self

Always show scroll bars

pub fn hide_scroll(self) -> Self

Never show scroll bars

pub fn animated(self, animated: bool) -> Self

Enable or disable animated scrolling

pub fn enable_scrolling(self, enable: bool) -> Self

Enable or disable scrolling entirely

pub fn scroll_offset(self, offset: Vec2) -> Self

Set initial scroll offset

pub fn show_ctx<Msg, R>( self, ctx: &mut ViewCtx<'_, Msg>, f: impl FnOnce(&mut ViewCtx<'_, Msg>) -> R, ) -> R

Show the scroll area with ViewCtx integration

pub fn show<R>( self, ui: &mut Ui, f: impl FnOnce(&mut Ui) -> R, ) -> ScrollAreaOutput<R>

Show the scroll area with raw egui::Ui

Trait Implementations

impl Clone for ScrollArea

fn clone(&self) -> ScrollArea

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ScrollArea

fn default() -> Self

Returns the “default value” for a type.