Snora documentation

Welcome. This directory holds long-form documentation for snora — tutorials, guides, architectural reference, and contributor notes. The generated API reference (per-function signatures and short doc comments) lives on docs.rs.

Two top-level files complement these docs: CHANGELOG records what changed in each release, and ROADMAP sketches what is expected next.

I am new to snora

Read these in order. Each is short and self-contained.

1. Install — add snora to your Cargo.toml.
2. Hello, snora — the smallest working app.
3. Add a header, sidebar, footer — fill the skeleton.
4. Toasts — notifications with framework-managed lifetime.
5. When to use snora — fit and non-fit guidance.

I have used snora before

Pick the topic you need.

• Overlays — dialogs, bottom sheets, context menus
• Header and context menus
• Direction and ABDD
• Icons — text, Lucide, SVG
• Testing UI logic without a renderer
• Migrating from 0.6 to 0.7
• Migrating from 0.5 to 0.6
• Migrating from 0.4 to 0.5

I want to look up a specific symbol or layout

• API reference (per-symbol): docs.rs/snora / docs.rs/snora-core
• Architecture overview — what snora-core and snora each contribute
• Vocabulary cheatsheet — every public enum at a glance
• Built-in widgets — the prefab app_header / app_side_bar / etc.

I want to contribute

Welcome — see the contributor docs:

• Internal architecture
• Design decisions — why the API looks the way it does
• Adding a new overlay kind
• Feature-gating criteria — when to split the widgets feature
• Release process