What is Awen?
Awen is a Storybook-like component explorer for Avalonia UI. It lets you develop, preview, and interact with your Avalonia controls in isolation.
SDK
A lightweight SDK for defining component stories. Implement the IStory interface, register your assemblies with [AwenStoryAssembly], and let Awen discover and render your UI components automatically.
- IStory Interface — the core contract for stories
- Story Structure — the 5-file convention for organizing stories
- Assembly Registration — marking assemblies for discovery and registering themes
User Interface
A visual explorer for browsing and interacting with your component stories. Navigate by category, see live previews, and iterate on your Avalonia UI components in real time.
- UI Overview — the three-panel layout and how panels connect
- Sidebar — hierarchical navigation with search filtering
- Preview Canvas — live rendering with viewport presets and theme switching
- Properties Panel — interactive editors for story state
- Log Panel — diagnostic output and error reporting
- Hot Reload — automatic reload when assemblies are rebuilt
How It Works
- You create a stories assembly — a .NET class library that references your controls and the Awen SDK
- Each story implements
IStory<TControl, TStoryProperties>with a preview wrapper and an editor panel - You run
Awen --dir <path>pointing at your compiled stories - Awen discovers stories via reflection and displays them in an interactive UI
Next Steps
- Installation — download or build Awen
- Quick Start — create your first story
- CLI Usage — all command-line options
- Examples — a complete example project