Struct UseAnimation

pub struct UseAnimation<Animated: AnimatedValue> { /* private fields */ }

Animate your elements. Use use_animation to use this.

Implementations

impl<Animated: AnimatedValue> UseAnimation<Animated>

pub fn get(&self) -> ReadOnlySignal<Animated>

Get the animated value.

pub fn reset(&self)

Reset the animation to the default state.

pub fn finish(&self)

Finish the animation with the final state.

pub fn is_running(&self) -> bool

Checks if there is any animation running.

pub fn has_run_yet(&self) -> bool

Checks if it has run yet, by subscribing.

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.

pub fn reverse(&self)

Runs the animation in reverse direction.

pub fn start(&self)

Runs the animation normally.

pub fn run(&self, direction: AnimDirection)

Run the animation with a given AnimDirection

Methods from Deref<Target = Signal<Animated>>

pub fn point_to(&self, other: Signal<T, S>) -> Result<(), BorrowError>

Point to another signal. This will subscribe the other signal to all subscribers of this signal.

pub fn manually_drop(&self)

Drop the value out of the signal, invalidating the signal in the process.

pub fn origin_scope(&self) -> ScopeId

Get the scope the signal was created in.

pub fn id(&self) -> GenerationalBoxId

Get the generational id of the signal.

pub fn write_silent(&self) -> <S as AnyStorage>::Mut<'static, T>

👎Deprecated: This pattern is no longer recommended. Prefer peek or creating new signals instead.

This pattern is no longer recommended. Prefer peek or creating new signals instead.

This function is the equivalent of the write_silent method on use_ref.

What you should use instead

Reading and Writing to data in the same scope

Reading and writing to the same signal in the same scope will cause that scope to rerun forever:

let mut signal = use_signal(|| 0);
// This makes the scope rerun whenever we write to the signal
println!("{}", *signal.read());
// This will rerun the scope because we read the signal earlier in the same scope
*signal.write() += 1;

You may have used the write_silent method to avoid this infinite loop with use_ref like this:

let signal = use_signal(|| 0);
// This makes the scope rerun whenever we write to the signal
println!("{}", *signal.read());
// Write silent will not rerun any subscribers
*signal.write_silent() += 1;

Instead you can use the peek and write methods instead. The peek method will not subscribe to the current scope which will avoid an infinite loop if you are reading and writing to the same signal in the same scope.

let mut signal = use_signal(|| 0);
// Peek will read the value but not subscribe to the current scope
println!("{}", *signal.peek());
// Write will update any subscribers which does not include the current scope
*signal.write() += 1;

Reading and Writing to different data

Why is this pattern no longer recommended?

This pattern is no longer recommended because it is very easy to allow your state and UI to grow out of sync. write_silent globally opts out of automatic state updates which can be difficult to reason about.

Lets take a look at an example: main.rs:

fn app() -> Element {
    let signal = use_context_provider(|| Signal::new(0));

    // We want to log the value of the signal whenever the app component reruns
    println!("{}", *signal.read());

    rsx! {
        button {
            // If we don't want to rerun the app component when the button is clicked, we can use write_silent
            onclick: move |_| *signal.write_silent() += 1,
            "Increment"
        }
        Child {}
    }
}

child.rs:

fn Child() -> Element {
    let signal: Signal<i32> = use_context();

    // It is difficult to tell that changing the button to use write_silent in the main.rs file will cause UI to be out of sync in a completely different file
    rsx! {
        "{signal}"
    }
}

Instead peek locally opts out of automatic state updates explicitly for a specific read which is easier to reason about.

Here is the same example using peek: main.rs:

fn app() -> Element {
    let mut signal = use_context_provider(|| Signal::new(0));

    // We want to log the value of the signal whenever the app component reruns, but we don't want to rerun the app component when the signal is updated so we use peek instead of read
    println!("{}", *signal.peek());

    rsx! {
        button {
            // We can use write like normal and update the child component automatically
            onclick: move |_| *signal.write() += 1,
            "Increment"
        }
        Child {}
    }
}

child.rs:

fn Child() -> Element {
    let signal: Signal<i32> = use_context();

    rsx! {
        "{signal}"
    }
}

Trait Implementations

impl<Animated: Clone + AnimatedValue> Clone for UseAnimation<Animated>

fn clone(&self) -> UseAnimation<Animated>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Animated: AnimatedValue> Deref for UseAnimation<Animated>

type Target = Signal<Animated>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Animated: PartialEq + AnimatedValue> PartialEq for UseAnimation<Animated>

fn eq(&self, other: &UseAnimation<Animated>) -> 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<T: AnimatedValue> Copy for UseAnimation<T>

impl<Animated: AnimatedValue> StructuralPartialEq for UseAnimation<Animated>