feat: on_deps_change method for animations (#977)

crates/components/src/switch.rs

@@ -15,6 +15,7 @@ use freya_hooks::{
     AnimNum,
     Ease,
     Function,
+    OnDepsChange,
     SwitchThemeWith,
 };
 use winit::window::CursorIcon;
@@ -67,6 +68,7 @@ pub enum SwitchStatus {
 pub fn Switch(props: SwitchProps) -> Element {
     let theme = use_applied_theme!(&props.theme, switch);
     let animation = use_animation_with_dependencies(&theme, |ctx, theme| {
+        ctx.on_deps_change(OnDepsChange::Run);
         (
             ctx.with(
                 AnimNum::new(2., 22.)

crates/hooks/src/use_animation.rs

@@ -379,6 +379,7 @@ pub struct Context {
     animated_values: Vec<Signal<Box<dyn AnimatedValue>>>,
     on_finish: OnFinish,
     auto_start: bool,
+    on_deps_change: OnDepsChange,
 }
 
 impl Context {
@@ -398,6 +399,11 @@ impl Context {
         self.auto_start = auto_start;
         self
     }
+
+    pub fn on_deps_change(&mut self, on_deps_change: OnDepsChange) -> &mut Self {
+        self.on_deps_change = on_deps_change;
+        self
+    }
 }
 
 /// Controls the direction of the animation.
@@ -425,6 +431,14 @@ pub enum OnFinish {
     Restart,
 }
 
+/// What to do once the animation dependencies change. By default it is [`Reset`](OnDepsChange::Reset)
+#[derive(PartialEq, Clone, Copy, Default)]
+pub enum OnDepsChange {
+    #[default]
+    Reset,
+    Run,
+}
+
 /// Animate your elements. Use [`use_animation`] to use this.
 #[derive(PartialEq, Clone)]
 pub struct UseAnimator<Animated: PartialEq + Clone + 'static> {
@@ -446,8 +460,11 @@ impl<Animated: PartialEq + Clone + 'static> UseAnimator<Animated> {
 
     /// Reset the animation to the default state.
     pub fn reset(&self) {
+        let mut has_run_yet = self.has_run_yet;
         let mut task = self.task;
 
+        has_run_yet.set(false);
+
         if let Some(task) = task.write().take() {
             task.cancel();
         }
@@ -721,8 +738,8 @@ where
     };
 
     use_memo(move || {
-        let _ = value_and_ctx.read();
-        if *has_run_yet.peek() {
+        let value_and_ctx = value_and_ctx.read();
+        if *has_run_yet.peek() && value_and_ctx.1.on_deps_change == OnDepsChange::Run {
             animator.run_update()
         }
     });