pub struct UseAnimation<Animated: AnimatedValue> { /* private fields */ }
Expand description
Animate your elements. Use use_animation
to use this.
Implementations§
Source§impl<Animated: AnimatedValue> UseAnimation<Animated>
impl<Animated: AnimatedValue> UseAnimation<Animated>
Sourcepub fn get(&self) -> ReadOnlySignal<Animated>
pub fn get(&self) -> ReadOnlySignal<Animated>
Get the animated value.
Sourcepub fn is_running(&self) -> bool
pub fn is_running(&self) -> bool
Checks if there is any animation running.
Sourcepub fn has_run_yet(&self) -> bool
pub fn has_run_yet(&self) -> bool
Checks if it has run yet, by subscribing.
Sourcepub fn peek_has_run_yet(&self) -> bool
pub fn peek_has_run_yet(&self) -> bool
Checks if it has run yet, doesn’t subscribe. Useful for when you just mounted your component.
Sourcepub fn run(&self, direction: AnimDirection)
pub fn run(&self, direction: AnimDirection)
Run the animation with a given AnimDirection
Trait Implementations§
Source§impl<Animated: Clone + AnimatedValue> Clone for UseAnimation<Animated>
impl<Animated: Clone + AnimatedValue> Clone for UseAnimation<Animated>
Source§fn clone(&self) -> UseAnimation<Animated>
fn clone(&self) -> UseAnimation<Animated>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl<T: AnimatedValue> PartialEq for UseAnimation<T>
impl<T: AnimatedValue> PartialEq for UseAnimation<T>
impl<T: AnimatedValue> Copy for UseAnimation<T>
Auto Trait Implementations§
impl<Animated> Freeze for UseAnimation<Animated>
impl<Animated> !RefUnwindSafe for UseAnimation<Animated>
impl<Animated> !Send for UseAnimation<Animated>
impl<Animated> !Sync for UseAnimation<Animated>
impl<Animated> Unpin for UseAnimation<Animated>where
Animated: Unpin,
impl<Animated> !UnwindSafe for UseAnimation<Animated>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> InitializeFromFunction<T> for T
impl<T> InitializeFromFunction<T> for T
Source§fn initialize_from_function(f: fn() -> T) -> T
fn initialize_from_function(f: fn() -> T) -> T
Create an instance of this type from an initialization function
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<Ret> SpawnIfAsync<(), Ret> for Ret
impl<Ret> SpawnIfAsync<(), Ret> for Ret
Source§impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
Source§fn super_from(input: T) -> O
fn super_from(input: T) -> O
Convert from a type to another type.
Source§impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
Source§fn super_into(self) -> O
fn super_into(self) -> O
Convert from a type to another type.