Struct PullToRefresh 

pub struct PullToRefresh { /* private fields */ }

Pull to refresh around caller-owned scrolling content.

The refreshing flag is controlled: Self::on_refresh reports a release past the threshold, and the caller sets Self::refreshing until its work is done. The gesture has no keyboard form, so give the screen a visible refresh control that calls the same handler.

use gpui_kit_material::prelude::*;

let list = PullToRefresh::new("inbox", "Refreshing the inbox")
    .indicator(PullToRefreshIndicator::LoadingIndicator)
    .on_refresh(|_, _| { /* start the work and set `refreshing` */ });

Implementations

impl PullToRefresh

pub fn new(id: impl Into<ElementId>, label: impl Into<SharedString>) -> Self

label names the indicator for assistive technology.

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

Whether a refresh is running: the indicator rests at the threshold, spinning, and pulls are ignored.

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

Ignore pulls.

pub fn indicator(self, indicator: PullToRefreshIndicator) -> Self

Which indicator to show.

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

The distance (dp, after the drag multiplier) a pull must pass.

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

Whether a mouse drag pulls (on by default).

pub fn track_scroll(self, scroll: &ScrollHandle) -> Self

The scroll position pulls start from. By default the element keeps its own; pass one to read or move the content’s position.

pub fn child(self, child: impl IntoElement) -> Self

Add to the scrolling content.

pub fn on_refresh( self, handler: impl Fn(&mut Window, &mut App) + 'static, ) -> Self

Called when a pull is released past the threshold.

Trait Implementations

impl IntoElement for PullToRefresh

type Element = ViewElement<PullToRefresh>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl RenderOnce for PullToRefresh

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.