leptos_motion/

lib.rs

//! # Leptos Motion
//!
//! A comprehensive animation library for Leptos with Framer Motion-inspired API.
//!
//! ## Features
//!
//! - **Declarative animations** with Motion-style API
//! - **Hardware acceleration** via Web Animations API with RAF fallback
//! - **Gesture support** for drag, hover, tap, and more
//! - **Layout animations** using FLIP technique
//! - **Scroll animations** with intersection observers
//! - **Type safety** with full Rust compile-time validation
//! - **High performance** targeting 60fps for 100+ concurrent animations
//! - **Animation presets** for common patterns
//! - **Keyframe animations** for complex multi-step animations
//! - **Variants** for named animation states
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use leptos::*;
//! use leptos_motion::*;
//! use std::collections::HashMap;
//!
//! #[component]
//! fn App() -> impl IntoView {
//!     let mut initial = HashMap::new();
//!     initial.insert("opacity".to_string(), AnimationValue::Number(0.0));
//!     initial.insert("scale".to_string(), AnimationValue::Number(0.5));
//!
//!     let mut animate = HashMap::new();
//!     animate.insert("opacity".to_string(), AnimationValue::Number(1.0));
//!     animate.insert("scale".to_string(), AnimationValue::Number(1.0));
//!
//!     view! {
//!         <MotionDiv
//!             class="my-element".to_string()
//!             initial=initial
//!             animate=animate
//!             transition=Transition {
//!                 duration: Some(0.5),
//!                 ease: Easing::EaseOut,
//!                 delay: None,
//!                 repeat: RepeatConfig::Never,
//!                 stagger: None,
//!             }
//!         >
//!             "Hello Leptos Motion!"
//!         </MotionDiv>
//!     }
//! }
//! ```
//!
//! ## Core Concepts
//!
//! ### Animation Values
//!
//! Animation values represent different types of animatable properties:
//!
//! ```rust,no_run
//! use leptos_motion::*;
//!
//! let opacity = AnimationValue::Number(1.0);
//! let position = AnimationValue::Pixels(100.0);
//! let rotation = AnimationValue::Degrees(45.0);
//! let color = AnimationValue::Color("#ff0000".to_string());
//! ```
//!
//! ### Transitions
//!
//! Configure how animations behave:
//!
//! ```rust,no_run
//! # use leptos_motion::*;
//! // Spring animation
//! let spring = Transition {
//!     ease: Easing::Spring(SpringConfig {
//!         stiffness: 100.0,
//!         damping: 10.0,
//!         mass: 1.0,
//!         ..Default::default()
//!     }),
//!     ..Default::default()
//! };
//!
//! // Tween animation
//! let tween = Transition {
//!     duration: Some(0.3),
//!     ease: Easing::EaseInOut,
//!     delay: Some(0.1),
//!     ..Default::default()
//! };
//! ```
//!
//! ### Gestures
//!
//! Add interactivity to your animations:
//!
//! ```rust,no_run
//! # use leptos::*;
//! # use leptos_motion::*;
//! # use std::collections::HashMap;
//! # fn main() {
//! let mut hover_target = HashMap::new();
//! hover_target.insert("scale".to_string(), AnimationValue::Number(1.1));
//!
//! let mut tap_target = HashMap::new();
//! tap_target.insert("scale".to_string(), AnimationValue::Number(0.9));
//!
//! let _view = view! {
//!     <MotionDiv
//!         while_hover=hover_target
//!         while_tap=tap_target
//!         drag=DragConfig::default()
//!     >
//!         "Interactive element"
//!     </MotionDiv>
//! };
//! # }
//! ```

#![warn(missing_docs)]
#![forbid(unsafe_code)]

// Re-export core functionality
pub use leptos_motion_core::{
    AnimationConfig, AnimationEngine, AnimationHandle, AnimationValue, Easing, RepeatConfig,
    Result, SpringConfig, Transition, animation, easing, spring,
};

// Re-export performance module if available
#[cfg(feature = "performance-metrics")]
pub use leptos_motion_core::performance;

// Re-export DOM functionality
pub use leptos_motion_dom::{
    AnimatePresence, DragAxis, DragConfig, DragConstraints, MotionDiv, MotionProps, MotionSpan,
    PresenceMode,
};

// Re-export macros
pub use leptos_motion_macros::motion_target;

#[cfg(feature = "gestures")]
pub use leptos_motion_gestures::*;

#[cfg(feature = "layout")]
pub use leptos_motion_layout::*;

#[cfg(feature = "scroll")]
pub use leptos_motion_scroll::*;

pub use leptos_motion_macros::*;

/// Animation presets and common patterns
pub mod presets {
    // Core animation presets
    pub use leptos_motion_core::animation::presets::*;
    pub use leptos_motion_core::easing::presets::*;
    pub use leptos_motion_core::spring::presets::*;
}

/// Re-export commonly used external types
pub mod external {
    pub use leptos::*;
    pub use wasm_bindgen::prelude::*;
    pub use web_sys::{Element, Event, HtmlElement, MouseEvent, TouchEvent};
}

/// Version information
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Library information
pub const DESCRIPTION: &str = env!("CARGO_PKG_DESCRIPTION");

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_version() {
        // VERSION and DESCRIPTION are compile-time constants
        // This test just verifies the constants are defined and have content
        assert!(VERSION.contains("0.8") || DESCRIPTION.contains("motion"));
    }

    #[test]
    fn test_animation_value_creation() {
        let opacity = AnimationValue::Number(1.0);
        let position = AnimationValue::Pixels(100.0);
        let rotation = AnimationValue::Degrees(45.0);

        assert_eq!(opacity, AnimationValue::Number(1.0));
        assert_eq!(position, AnimationValue::Pixels(100.0));
        assert_eq!(rotation, AnimationValue::Degrees(45.0));
    }

    #[test]
    fn test_transition_creation() {
        let transition = Transition {
            duration: Some(1.0),
            ease: Easing::Spring(SpringConfig::default()),
            ..Default::default()
        };

        assert_eq!(transition.duration, Some(1.0));
        assert!(matches!(transition.ease, Easing::Spring(_)));
    }
}