Awen.Sdk
1.2.0
dotnet add package Awen.Sdk --version 1.2.0
NuGet\Install-Package Awen.Sdk -Version 1.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Awen.Sdk" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Awen.Sdk" Version="1.2.0" />
<PackageReference Include="Awen.Sdk" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Awen.Sdk --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Awen.Sdk, 1.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Awen.Sdk@1.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Awen.Sdk&version=1.2.0
#tool nuget:?package=Awen.Sdk&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Awen
Storybook-like component explorer for Avalonia UI. Develop, preview, and interact with your Avalonia controls in isolation.
Features
- Live preview — render controls in an interactive canvas with viewport presets and theme switching
- Hot reload — automatically reload stories when assemblies are rebuilt
- Sidebar navigation — browse stories by category with search filtering
- Properties panel — interactively edit story state at runtime
- Log panel — diagnostic output and error reporting
- Cross-platform — runs on Linux and Windows
Quick Start
1. Install Awen
Download a pre-built binary from GitHub Releases, or build from source:
git clone https://github.com/ryandanthony/awen.git
cd awen
dotnet build
2. Add the SDK
Install the Awen.Sdk NuGet package in your stories project:
dotnet add package Awen.Sdk
3. Register Your Assembly
Create an AssemblyInfo.cs in your stories project:
using Awen.Sdk;
[assembly: AwenStoryAssembly("My Controls")]
4. Write a Story
Implement the IStory<TControl, TStoryProperties> interface to define a previewable component scenario:
public class PrimaryButtonStory : IStory<PrimaryButtonPreview, PrimaryButtonProperties>
{
public string Name => "Primary Button";
public string Group => "Buttons";
// ...
}
5. Run Awen
Awen --dir ./MyControls.Stories/bin/Debug/net10.0/
CLI Usage
Awen --dir <path> [--watch] [--no-watch] [--theme <light|dark>] [--filter <pattern>]
| Option | Description |
|---|---|
--dir <path> |
Required. Directory containing compiled story assemblies. |
--watch |
Enable hot-reload (default: true). |
--no-watch |
Disable hot-reload. |
--theme <variant> |
Initial theme — light or dark. |
--filter <pattern> |
Filter stories by name or group path. |
Documentation
Full documentation is available at the Awen docs site.
Project Structure
src/
Awen/ # CLI application and UI
Awen.Sdk/ # Lightweight SDK for authoring stories
examples/
ExampleUI/ # Sample Avalonia controls
ExampleUI.Stories/ # Sample stories
tests/
Awen.Tests/ # Application tests
Awen.Sdk.Tests/ # SDK tests
docs/ # Documentation source
website/ # Docusaurus site
Prerequisites
License
MIT © Ryan Anthony
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Avalonia (>= 11.3.12)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.