Expose a chain module to easily import for some animations

Particulatly animations that are triggered from an interaction,
and the animation needs to be passed thtough a message.

Author: 13r0ck

src/keyframes.rs

@@ -19,7 +19,7 @@ pub use column::Column;
 pub use container::Container;
 pub use helpers::id;
 pub use helpers::lazy;
-pub use helpers::{button, column, container, row, space, style_button, style_container};
+pub use helpers::{button, column, container, row, space, style_button, style_container, chain};
 pub use row::Row;
 pub use space::Space;
 pub use style_button::StyleButton;

src/keyframes/helpers.rs

@@ -99,3 +99,9 @@ pub mod id {
         toggler::Id as Toggler,
     };
 }
+
+/// Direct access to `Chain`s for widget that may return an animation
+/// in a message.
+pub mod chain {
+  pub use crate::keyframes::toggler::Chain as Toggler;
+}

src/keyframes/toggler.rs

@@ -45,13 +45,17 @@ impl From<Id> for IcedId {
 }
 
 #[derive(Debug, Clone)]
+/// An animation, where each keyframe is "chained" together.
 pub struct Chain {
     id: Id,
     links: Vec<Toggler>,
     repeat: Repeat,
 }
 
 impl Chain {
+    /// Crate a new [`Toggler`] animation chain.
+    /// You probably don't want to use use directly, and should
+    /// use the [`chain`] macro.
     pub fn new(id: Id) -> Self {
         Chain {
             id,
@@ -60,6 +64,9 @@ impl Chain {
         }
     }
 
+    /// Create a chain pre-fulled with children.
+    /// You probably don't want to use use directly, and should
+    /// use the [`chain`] macro.
     pub fn with_children(id: Id, children: Vec<Toggler>) -> Self {
         Chain {
             id,
@@ -68,16 +75,24 @@ impl Chain {
         }
     }
 
+    /// Link another keyframe, (very similar to push)
+    /// You probably don't want to use use directly, and should
+    /// use the [`chain`] macro.
     pub fn link(mut self, toggler: Toggler) -> Self {
         self.links.push(toggler);
         self
     }
 
+    /// Sets the animation to loop forever.
     pub fn loop_forever(mut self) -> Self {
         self.repeat = Repeat::Forever;
         self
     }
 
+    /// Sets the animation to only loop once.
+    /// This is the default, and only useful to
+    /// stop an animation that was previously set
+    /// to loop forever.
     pub fn loop_once(mut self) -> Self {
         self.repeat = Repeat::Never;
         self

src/lib.rs

@@ -138,7 +138,7 @@ pub mod widget;
 mod keyframes;
 
 pub use crate::keyframes::{
-    button, column, container, id, lazy, row, space, style_button, style_container,
+    button, column, container, id, lazy, row, space, style_button, style_container, chain,
 };
 pub use crate::timeline::{Chain, Timeline};