API Overview
This section is a map, not a full manual.
Use it to answer three questions:
- which crate owns this concept?
- which page should I read before opening rustdoc?
- what boundary does this crate own in the framework?
Exact methods, generics, and trait bounds should still come from rustdoc.
Crate map
| crate | owns | start here |
|---|---|---|
ansiq | the default umbrella entry point and prelude for new users | ansiq |
ansiq-core | reactivity, Element, styles, history, widget state | ansiq-core |
ansiq-runtime | App, main loop, RuntimeHandle, localized update orchestration | ansiq-runtime |
ansiq-surface | terminal session, viewport policy, history commit | ansiq-surface |
ansiq-widgets | low-level widgets and higher-level compositions | ansiq-widgets |
ansiq-macros | the view! macro and declarative tree construction | ansiq-macros |
Choose by question
If your question is:
- “how should I model state?” read Signals and Hooks
- “what can the app lifecycle do?” read ansiq-runtime
- “which viewport policy should I use?” read ansiq-surface
- “how do I use a widget?” read Widgets Overview
Suggested order
If you want a systematic path through the API, use this order:
Last updated on