Struct ScrollView 

pub struct ScrollView { /* private fields */ }

Scrollable area with bidirectional support and scrollbars.

It renders all of its children and scrolls over them, which makes it a good fit for small or medium amounts of content. For large data sets prefer VirtualScrollView, which only renders the visible items. It scrolls vertically by default, use direction for a horizontal layout. To drive the scroll position from code, build it with new_controlled and a ScrollController.

Example

fn app() -> impl IntoElement {
    ScrollView::new()
        .child("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum laoreet tristique diam, ut gravida enim. Phasellus viverra vitae risus sit amet iaculis. Morbi porttitor quis nisl eu vulputate. Etiam vitae ligula a purus suscipit iaculis non ac risus. Suspendisse potenti. Aenean orci massa, ornare ut elit id, tristique commodo dui. Vestibulum laoreet tristique diam, ut gravida enim. Phasellus viverra vitae risus sit amet iaculis. Vestibulum laoreet tristique diam, ut gravida enim. Phasellus viverra vitae risus sit amet iaculis. Vestibulum laoreet tristique diam, ut gravida enim. Phasellus viverra vitae risus sit amet iaculis.")
}

Preview

Implementations

impl ScrollView

pub fn new() -> Self

Creates an uncontrolled scroll view that manages its own scroll position.

pub fn new_controlled(scroll_controller: ScrollController) -> Self

Creates a scroll view driven by the given ScrollController.

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

Toggles whether the scrollbars are shown when the content overflows.

pub fn direction(self, direction: Direction) -> Self

Sets the layout direction the children flow and scroll in.

pub fn spacing(self, spacing: impl Into<f32>) -> Self

Sets the gap between children along the scroll direction.

pub fn scroll_with_arrows(self, scroll_with_arrows: impl Into<bool>) -> Self

Toggles whether the arrow keys scroll the view while it is focused.

pub fn invert_scroll_wheel(self, invert_scroll_wheel: impl Into<bool>) -> Self

Inverts the direction of the mouse wheel relative to the content.

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

Toggles scrolling by dragging the content, useful mainly for touch input.

pub fn max_width(self, max_width: impl Into<Size>) -> Self

Caps the width of the scroll view.

pub fn max_height(self, max_height: impl Into<Size>) -> Self

Caps the height of the scroll view.

Trait Implementations

impl ChildrenExt for ScrollView

fn get_children(&mut self) -> &mut Vec<Element>

Returns a mutable reference to the internal children vector.

fn children(self, children: impl IntoIterator<Item = Element>) -> Self

Extends the children with an iterable of [Element]s.

fn maybe_child<C>(self, child: Option<C>) -> Self

where C: IntoElement,

Appends a child only when the Option is Some.

fn child<C>(self, child: C) -> Self

where C: IntoElement,

Appends a single child element.

impl Clone for ScrollView

fn clone(&self) -> ScrollView

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: &ScrollView) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerPositionExt for ScrollView

fn position(self, position: impl Into<Position>) -> Self

Set how the element is placed relative to its parent or the window. See [Position].

impl ContainerSizeExt for ScrollView

fn width(self, width: impl Into<Size>) -> Self

Set the element’s width. See [Size].

fn height(self, height: impl Into<Size>) -> Self

Set the element’s height. See [Size].

fn expanded(self) -> Self

Expand both width and height using [Size::fill()].

impl Default for ScrollView

fn default() -> Self

Returns the “default value” for a type.

impl KeyExt for ScrollView

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.

impl LayoutExt for ScrollView

fn get_layout(&mut self) -> &mut LayoutData

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See [LayoutData].

impl PartialEq for ScrollView

fn eq(&self, other: &ScrollView) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScrollView