Skip to main content

TopAppBarScrollBehavior

Struct TopAppBarScrollBehavior 

Source
pub struct TopAppBarScrollBehavior {
    pub collapsed_offset: Signal<f32>,
    pub height: f32,
    pub collapsed_height: f32,
    pub mode: TopAppBarScrollMode,
    /* private fields */
}
Expand description

Drives scroll-based collapsing/expanding of a TopAppBar.

Create one, pass its nested_scroll_connection to a lazy list’s [set_nested_scroll_parent] method, and set the resulting collapsed_offset on the TopAppBar via TopAppBarConfig::scroll_offset.

Fields§

§collapsed_offset: Signal<f32>§height: f32§collapsed_height: f32§mode: TopAppBarScrollMode

Implementations§

Source§

impl TopAppBarScrollBehavior

Source

pub fn new( height: f32, collapsed_height: f32, mode: TopAppBarScrollMode, ) -> Self

Source

pub fn nested_scroll_connection(&self) -> NestedScrollConnection

Returns a NestedScrollConnection that collapses the bar on downward scroll and expands on upward scroll.

Source

pub fn offset(&self) -> f32

Returns the current collapsed offset (0 = fully expanded, negative = collapsed).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.