hikari-animation 0.3.14

Animation hooks, easing functions and transition utilities for the Hikari design system
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! # Hikari Animation System
//!
//! A high-performance, declarative animation system with support for dynamic values,
//! complex timelines, and smooth transitions.
//!
//! ## Architecture
//!
//! The animation system is built on several core components:
//!
//! - **[`config`]** - Global animation configuration (enabled, duration_scale, reduced_motion)
//! - **[`builder`]** - Fluent builder API for creating animations with static and dynamic values
//! - **[`context`]** - Runtime context providing element dimensions, mouse position, and other state
//! - **[`style`]** - Type-safe CSS property manipulation with [`StyleBuilder`]
//! - **[`easing`]** - Easing functions for natural motion (ease-in-out, bounce, elastic, etc.)
//! - **[`tween`]** - Interpolation system for smooth value transitions
//! - **[`timeline`]** - Timeline-based animation sequencing
//! - **[`presets`]** - Pre-built animation presets (fade, slide, scale, etc.)
//! - **[`events`]** - Animation event system
//! - **[`timer`]** - High-precision timer for frame-based animations
//! - **[`core`]** - Core animation primitives and utilities
//!
//! ## Features
//!
//! - **Type-Safe CSS**: Compile-time checked CSS properties
//! - **Dynamic Values**: Compute animation values at runtime from context
//! - **Multi-Element**: Control multiple DOM elements simultaneously
//! - **Easing Functions**: 30+ easing functions for natural motion
//! - **Timeline Control**: Sequence and coordinate complex animations
//! - **Framework Agnostic**: Core works without any specific UI framework
//! - **Reduced Motion**: Automatic prefers-reduced-motion detection
//!
//! ## Feature Flags
//!
//! - `wasm` - Enable WASM/browser integration, including tairitsu hooks and components
//!
//! When the `wasm` feature is enabled, you also get:
//! - **[`provider`]** - AnimationProvider component for the tairitsu context system
//! - **[`hooks`]** - Hooks for animation lifecycle management (built on `tairitsu-hooks`)

pub mod breathing;
pub mod config;
pub mod core;
pub mod easing;
pub mod presets;
pub mod state;
pub mod state_machine;
pub mod timeline;
pub mod tween;

// Pure Rust modules (no wasm-bindgen required)
pub use breathing::*;
pub use config::AnimationConfig;
pub use core::*;
pub use easing::*;
pub use presets::*;
pub use state::*;
pub use state_machine::*;
pub use timeline::*;
pub use tween::*;

// Modules that use browser APIs (and, for some, tairitsu hooks)
#[cfg(feature = "wasm")]
pub mod builder;
#[cfg(feature = "wasm")]
pub mod context;
#[cfg(feature = "wasm")]
pub mod events;
#[cfg(feature = "wasm")]
pub mod lifecycle;
#[cfg(feature = "wasm")]
pub mod prefers_reduced_motion;
#[cfg(feature = "wasm")]
pub mod scrollbar;
#[cfg(feature = "wasm")]
pub mod style;
#[cfg(feature = "wasm")]
pub mod timer;

// Re-export WASM-specific items
#[cfg(feature = "wasm")]
pub use builder::*;
#[cfg(feature = "wasm")]
pub use context::AnimationContext;
#[cfg(feature = "wasm")]
pub use events::*;
#[cfg(feature = "wasm")]
pub use lifecycle::*;
#[cfg(feature = "wasm")]
pub use prefers_reduced_motion::{prefers_reduced_motion, watch_prefers_reduced_motion};
#[cfg(feature = "wasm")]
pub use scrollbar::*;
#[cfg(feature = "wasm")]
pub use style::*;
#[cfg(feature = "wasm")]
pub use timer::*;

// tairitsu-specific modules (require the wasm feature + browser APIs)
#[cfg(feature = "wasm")]
pub mod glow;
#[cfg(feature = "wasm")]
pub mod hooks;
#[cfg(feature = "wasm")]
pub mod provider;

#[cfg(feature = "wasm")]
pub mod global_manager;

// Re-export tairitsu-specific items
#[cfg(feature = "wasm")]
pub use glow::Glow;
#[cfg(feature = "wasm")]
pub use hooks::*;
#[cfg(feature = "wasm")]
pub use provider::{
    AnimationContext as AnimationProviderContext, AnimationProvider, try_use_animation_config,
    use_animation_config, use_animation_duration_scale, use_animation_enabled,
    use_animation_reduced_motion,
};

// Re-export transition presets for convenience (only available with wasm feature)
#[cfg(all(feature = "wasm", target_arch = "wasm32", target_os = "unknown"))]
pub use presets::transition::{
    SlideDirection, bounce_in, fade_in, fade_out, rotate_in, rotate_out, shake, slide_in,
    slide_out, zoom_in, zoom_out,
};