Skip to content

Latest commit

 

History

History

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

ShellUI Native Examples

This folder contains example projects demonstrating ShellUI Native components.

Projects

Project Platform Description
MAUI.Demo .NET MAUI Complete MAUI app showcasing all components
Avalonia.Demo Avalonia 12 Avalonia components as they are ported (Phase 2)
Avalonia.Preview Avalonia 12 on WebAssembly One component per URL, for the live previews on the docs site
WinUI.Demo WinUI 3 (Coming Soon)
WPF.Demo WPF (Coming Soon)

Running Examples

MAUI Demo

cd examples/MAUI.Demo
dotnet restore
dotnet build

# Run on Windows
dotnet run -f net10.0-windows10.0.19041.0

# Run on Android
dotnet run -f net10.0-android

# Run on iOS (macOS only)
dotnet run -f net10.0-ios

Avalonia Demo

dotnet run --project examples/Avalonia.Demo/AvaloniaDemo.csproj

Runs on Windows, macOS and Linux.

Avalonia Preview

The Avalonia components running in the browser. It compiles the demo's own component files, and shows the preview named in the address: ?c=button, with &theme=dark or &theme=light.

dotnet workload install wasm-tools
dotnet run --project examples/Avalonia.Preview/AvaloniaPreview.csproj
dotnet publish examples/Avalonia.Preview/AvaloniaPreview.csproj -c Release

A preview is one file, Previews/<name>.axaml: the markup the docs page shows, inside a panel that places it. The ones here are samples. The docs site keeps a preview for every example in its own repository and builds this project with -p:PreviewsDir=<that folder> (.axaml files, their .axaml.cs files, and pictures under assets/, addressed as /Assets/<file>).

The project is not in the solution, so building the solution doesn't need the workload.

Purpose

These examples serve as:

  1. Component Testing - Verify components work correctly during development
  2. User Reference - Show real-world usage patterns
  3. CI/CD Validation - Automated builds ensure everything works
  4. Documentation - Living examples of best practices