docs

Animato Documentation

This directory contains the stable v1.7.2 documentation for Animato. Use it with the generated API docs on docs.rs.

Start Here

Guide	Use it for
Getting Started	First tween, update loop, and value read.
Installation	Cargo setup, features, no_std, WASM, Bevy.
Concepts	Core traits and runtime model.
API Full	Stable public API map by crate.
Feature Flags	Facade and sub-crate feature requirements.

Feature Guides

Area	Guide
Tweens and keyframes	tween.md
Timelines and sequences	timeline.md
Springs	spring.md
Paths, SVG, morphing	path.md
Input physics	physics.md
Color interpolation	color.md
Drivers and clocks	driver.md
GPU batching	gpu.md
Bevy	bevy.md
WASM and DOM	wasm.md
Leptos	leptos.md
Dioxus	dioxus.md
Yew	yew.md
JavaScript	javascript.md
Advanced engine	advanced-engine.md
DevTools	devtools.md

Operations

Guide	Use it for
Examples	Running every example target.
Recipes	Practical app patterns.
Performance	Hot path and allocation guidance.
Benchmarks	Benchmark coverage and release baseline.
Testing	Local and CI test commands.
Release	Publishing checklist.
Migration	Moving to v1.0.0.
Troubleshooting	Common setup and feature issues.
FAQ	Short answers to common questions.

Minimal Install

[dependencies]
animato = "1.7.2"

First Animation

use animato::{Easing, Tween, Update};

let mut tween = Tween::new(0.0_f32, 1.0)
    .duration(0.25)
    .easing(Easing::EaseOutCubic)
    .build();

tween.update(0.125);
let opacity = tween.value();
assert!(opacity > 0.0 && opacity < 1.0);

Stable Contract

Animato v1.7.2 keeps the v1 public API stable and includes the Motion Macro DSL, runtime DevTools, inspection, tuning, recording, performance monitoring, and a complete retained enter/exit/FLIP lifecycle for Leptos animated lists. Public items are documented and covered by tests, and breaking changes require a future major release.