Struct Scroll 

pub struct Scroll { /* private fields */ }

A scroll view

Implementations

impl Scroll

pub fn new(child: impl IntoView) -> Scroll

Creates a new scroll view wrapping the given child view.

Example

use floem::views::*;

let content = Label::new("Scrollable content");
let scrollable = Scroll::new(content);

impl Scroll

pub fn ensure_visible(self, to: impl Fn() -> Rect + 'static) -> Scroll

Ensures that a specific rectangular area is visible within the scroll view by automatically scrolling to it if necessary.

Reactivity

The viewport will automatically update to include the target rectangle whenever the rectangle’s position or size changes, as determined by the to function which will update any time there are changes in the signals that it depends on.

pub fn scroll_delta(self, delta: impl Fn() -> Vec2 + 'static) -> Scroll

Scrolls the view by the specified delta vector.

Reactivity

The scroll position will automatically update whenever the delta vector changes, as determined by the delta function which will update any time there are changes in the signals that it depends on.

pub fn scroll_to(self, origin: impl Fn() -> Option<Point> + 'static) -> Scroll

Scrolls the view to the specified target point.

Reactivity

The scroll position will automatically update whenever the target point changes, as determined by the origin function which will update any time there are changes in the signals that it depends on.

pub fn scroll_to_percent(self, percent: impl Fn() -> f32 + 'static) -> Scroll

Scrolls the view to the specified percentage (0-100) of its scrollable content.

Reactivity

The scroll position will automatically update whenever the target percentage changes, as determined by the percent function which will update any time there are changes in the signals that it depends on.

pub fn scroll_to_view( self, view: impl Fn() -> Option<ViewId> + 'static, ) -> Scroll

Scrolls the view to make a specific view visible.

Reactivity

The scroll position will automatically update whenever the target view changes, as determined by the view function which will update any time there are changes in the signals that it depends on.

impl Scroll

internal methods

pub fn do_ensure_visible(&mut self, rect: Rect)

Ensure that an entire area is visible in the scroll view.

Scrolls the minimum distance necessary to make the entire rect visible. If the rect is larger than the viewport, prioritizes showing the top-left.

Arguments

• rect - The rectangle in content coordinates (relative to the child’s layout)

Trait Implementations

impl CustomStylable<ScrollCustomStyle> for Scroll

type DV = Scroll

The view type that this custom stylable converts to.

fn custom_style(self, style: impl Fn(S) -> S + 'static) -> Self::DV

Applies custom styling to the view with access to specialized custom style methods.

impl View for Scroll

fn id(&self) -> ViewId

fn debug_name(&self) -> Cow<'static, str>

fn view_style(&self) -> Option<Style>

fn update(&mut self, _cx: &mut UpdateCx<'_>, state: Box<dyn Any>)

Use this method to react to changes in view-related state. You will usually send state to this hook manually using the View’s Id handle

fn style_pass(&mut self, cx: &mut StyleCx<'_>)

Use this method to style the view’s children.

fn event(&mut self, cx: &mut EventCx<'_>) -> EventPropagation

Handles an event during the target and bubble phases of event propagation.

fn paint(&mut self, cx: &mut PaintCx<'_>)

View-specific implementation. Called during paint traversal for this view. Children are painted automatically by Floem. Views should only paint their own content (backgrounds, borders, custom drawing).

fn view_class(&self) -> Option<StyleClassRef>

fn event_capture(&mut self, _cx: &mut EventCx<'_>) -> EventPropagation

Handles an event during the capture phase of event propagation.

fn post_paint(&mut self, cx: &mut PaintCx<'_>)