Creating minimal Avalonia next generation (NXUI, next-gen UI) application using C# 10 and .NET 8
s6WC0Uol0x.mp4
<PackageReference Include="NXUI" Version="12.0.0" />Additionally, depending on the application type:
For Desktop extensions:
<PackageReference Include="NXUI.Desktop" Version="12.0.0" />or using plain Avalonia:
<PackageReference Include="Avalonia.Desktop" Version="12.0.0" /><PackageReference Include="Avalonia.Browser" Version="12.0.0" />dotnet workload install wasm-tools
NXUI builders now capture the full UI tree so hot reload can diff it. Return the builder
from your entry point and run the app through HotReloadHost.Run (shipped with
NXUI.Desktop) so NXUI can attach the component and reconcile live updates:
object Build() =>
Window()
.Title("NXUI")
.Content(Label().Content("NXUI"));
return HotReloadHost.Run(Build, "NXUI", args);var count = 0;
object Build()
=> Window(out var window)
.Title("NXUI").Width(400).Height(300)
.Content(
StackPanel()
.Children(
Button(out var button)
.Content("Welcome to Avalonia, please click me!"),
TextBox(out var tb1)
.Text("NXUI"),
TextBox()
.Text(window.BindTitle()),
Label()
.Content(button.ObserveOnClick().Select(_ => ++count).Select(x => $"You clicked {x} times."))))
.Title(tb1.ObserveText().Select(x => x?.ToUpper()));
return HotReloadHost.Run(Build, "NXUI", args);HotReloadHost automatically falls back to materializing the window when hot reload is
disabled, so the same entry point works for Release builds without extra flags.
If you need to pass a concrete window to Avalonia (for example when integrating into a
custom lifetime), call .Mount() on the builder before returning it:
Window Build()
=> Window()
.Title("NXUI")
.Content(Label().Content("NXUI"))
.Mount();
AppBuilder.Configure<Application>()
.UsePlatformDetect()
.UseFluentTheme()
.StartWithClassicDesktopLifetime(Build, args);Minimalistic Desktop app:
return HotReloadHost.Run(
() => Window().Content(Label().Content("NXUI")),
"NXUI",
args,
ThemeVariant.Dark);C#
cd src/Generator
dotnet run -- ../NXUI/GeneratedF#
cd src/Generator
dotnet run -- ../NXUI.FSharp/Generated -fsharpUsing .NET 10 you can run GUI apps using scripts: https://devblogs.microsoft.com/dotnet/announcing-dotnet-run-app/#using-shebang-lines-for-shell-scripts
Note: You might need to adjust shebang line to #!/usr/bin/dotnet run
App.cs
#!/usr/local/share/dotnet/dotnet run
#:package NXUI.Desktop@12.0.0
using Avalonia.Controls;
using Avalonia.Styling;
using NXUI.HotReload;
using static NXUI.Builders;
return HotReloadHost.Run(
() => Window().Content(Label().Content("NXUI")),
"NXUI",
args,
ThemeVariant.Dark,
ShutdownMode.OnLastWindowClose);chmod +x App.cs
./App.csMore complex app:
#!/usr/local/share/dotnet/dotnet run
#:package NXUI.Desktop@12.0.0
using NXUI.HotReload;
using static NXUI.Builders;
var count = 0;
object Build()
=> Window(out var window)
.Title("NXUI").Width(400).Height(300)
.Content(
StackPanel()
.Children(
Button(out var button)
.Content("Welcome to Avalonia, please click me!"),
TextBox(out var tb1)
.Text("NXUI"),
TextBox()
.Text(window.BindTitle()),
Label()
.Content(button.ObserveOnClick().Select(_ => ++count).Select(x => $"You clicked {x} times."))))
.Title(tb1.ObserveText().Select(x => x?.ToUpper()));
return HotReloadHost.Run(Build, "NXUI", args);From F# 9.0 and above the compiler resolves extension methods instead of instrinsic properties so, there's no need for a separate F# package or any additional changes to your project files.
Extension methods provided by the main package NXUI
open Avalonia
open Avalonia.Controls
open NXUI.Extensions
open NXUI.HotReload
open type NXUI.Builders
let Build () : obj =
let mutable count = 0
let mutable window = Unchecked.defaultof<Window>
let mutable button = Unchecked.defaultof<Button>
let mutable tb1 = Unchecked.defaultof<TextBox>
Window(window)
.Title("NXUI")
.Width(400)
.Height(300)
.Content(
StackPanel()
.Children(
Button(button).Content("Welcome to Avalonia, please click me!"),
TextBox(tb1).Text("NXUI"),
TextBox().Text(window.BindTitle()),
Label()
.Content(
button.ObserveOnClick()
|> Observable.map (fun _ ->
count <- count + 1
count)
|> Observable.map (fun x -> $"You clicked {x} times.")
|> _.ToBinding()
)
)
)
.Title(tb1.ObserveText())
|> box
[<EntryPoint>]
let Main argv = HotReloadHost.Run(Build, "NXUI", argv)The compiler feature is available in the .NET9 SDK and above so even if you target a lower dotnet version you don't need to change your project files.
However, if you must to use the .NET10 SDK explicitly you only need to set the language version to preview In your *.fsproj project and you'll get the same benefits.
<PropertyGroup> <TargetFramework>net10.0</TargetFramework> <LangVersion>preview</LangVersion> </PropertyGroup>
NXUI ships with a rich set of extension methods and builder helpers so that all UI composition can be expressed in C#. The code generator produces most of these members for every Avalonia control and property.
NXUI.Builders exposes factory methods for every control type. Each method
creates the control instance and overloads let you capture it via out var for
later use.
For each Avalonia property the following methods are generated:
<Name>(value)– set the property value.<Name>(IBinding, mode, priority)– bind with an Avalonia binding.<Name>(IObservable<T>, mode, priority)– bind from an observable.Bind<Name>(mode, priority)– create a binding descriptor.Observe<Name>()– observable of property values.On<Name>(handler)– pass the observable to a handler.ObserveBinding<Name>()– observe binding values including errors.OnBinding<Name>(handler)– receive the binding observable.Observe<Name>Changed()– observe full change events.On<Name>Changed(handler)– handler for change observable.
Enum properties get convenience methods for each enum value, e.g.
HorizontalAlignmentCenter().
For routed and CLR events:
ObserveOn<EventName>(routes)– returns anIObservablesequence.On<EventName>(handler, routes)– handler receiving the observable.On<EventName>Handler(action, routes)– attach a simple callback.
Set<ClassName><PropertyName> methods on Style and KeyFrame let you define
style values using constants, bindings or observables.
NXUI.Extensions.AvaloniaObjectExtensions provides BindOneWay and
BindTwoWay to link properties or observables without verbose binding code.
NXUI.Extensions.ReactiveObservableExtensions adds utilities for reactive
workflows:
ObserveOnUiThread/SubscribeOnUiThreadTakeUntilDetachedFromVisualTree/SubscribeUntilDetachedDisposeWithDataTemplate<T>WhenAnyValue(single or multiple expressions)
Together these extensions enable complex, reactive UIs built entirely in code while managing resources with minimal overhead.
-
Hot reload is always on – every NXUI project now emits builder-based controls and ships the hot reload runtime by default. No MSBuild properties or preprocessor symbols are required.
-
Run through the host – wrap your entry point with
HotReloadHost.Runso NXUI can register the component and reconcile live instances:using NXUI.HotReload; object Build() => Window() .Title("NXUI Hot Reload") .Content(Label().Content("Edit a file and save to trigger hot reload.")); return HotReloadHost.Run(Build, "SampleApp", args);
-
Use
dotnet watchor IDE hot reload – the runtime listens for metadata updates and callsNodeRenderer.Reconcilewith the previous node snapshot. The window stays mounted and control state (e.g.,TextBox.Text) survives. -
Turn on diagnostics when needed – set
NXUI_HOTRELOAD_DIAGNOSTICS=1to see per-reconciliation summaries, including counts for property sets, child add/remove/move operations, and replacements. -
Implicit boundaries (optional) – set
<EnableNXUIHotReloadBoundaries>true</EnableNXUIHotReloadBoundaries>to weave[HotReloadBoundary]onto controls listed inbuild/HotReloadBoundaries.json. Samples do this automatically for Debug builds viasamples/Directory.Build.props. Usedotnet run --project src/NXUI.Cli -- hotreload boundaries --manifest build/HotReloadBoundaries.json --assembly path/to/MyApp.dllto inspect which controls were annotated (manifest hits, explicit attributes, or state-adapter skips). The same Fody pass also injects[assembly: MetadataUpdateHandler(typeof(NXUI.HotReload.HotReloadMetadataUpdateHandler))], so IDE /dotnet watchnotifications reach NXUI without manual attributes.
- No updates apply – ensure your builder delegate returns an
ElementNodetree (not.Mount()ed controls) and that it is hosted byHotReloadHost.Run. - State resets on list changes – provide explicit
.Key("stable-id")for repeating builders or wrap complex containers with.HotReloadBoundary()so the diff engine can reason about reuse. Seedocs/hot-reload-best-practices.mdfor patterns. - Bindings/events stop firing – check analyzer warnings (see
NXUI.Analyzers) and confirm you are not instantiating Avalonia controls manually; the builder pipeline must remain in control for hot reload to succeed. - Layout thrash during updates – enable diagnostics to ensure excessive replacements are not happening; large replace counts often mean missing keys or boundaries.
- The hot reload runtime now ships in every build configuration.
NXUI.propsinjects the requiredRuntimeHostConfigurationOptionautomatically so metadata updates flow without extra project tweaks. - When trimming, keep
NXUI.HotReload.*rooted (the shipped linker descriptors already do this) if you want hot reload support in the published app.
docs/hot-reload-architecture.md– end-to-end design.docs/hot-reload-implementation-plan.md– milestone tracking.docs/hot-reload-best-practices.md– guidance forKey()andHotReloadBoundary()usage.