NavigationFrame.Avalonia 2.0.5

NavigationFrame.Avalonia

A modern, flexible, and source-generator-powered navigation framework for Avalonia applications. Inspired by Blazor and web navigation patterns, it brings strongly-typed routing, powerful layout systems, and automatic ViewModel wiring to your desktop apps.

✨ Key Features

• Source Generator Powered: Zero runtime reflection for route discovery. Routes are generated at compile time for maximum performance and type safety.
• Strongly Typed Navigation: Say goodbye to magic strings. Navigate using objects (e.g., navigator.NavigateAsync(new ProductRoute(123))).
• Smart ViewModel Inference: Automatically locates and wires up ViewModels based on naming conventions (e.g., HomePage → HomeViewModel). Supports 4 distinct lookup strategies.
• Advanced Layout System: Support for nested layouts (Master → Settings → UISettingsPage) using the [Layout] attribute.
• Rich Lifecycle Management: Granular interfaces (INavigatingFrom, IPreloadable, INavigatedTo, etc.) to handle data loading, navigation guards, and cleanup.
• Smart UX Features:
  • Built-in Transitions: Easy-to-use animations (Slide, Fade, Zoom) configurable globally or per-route.
  • Intelligent Progress Indicator: IsNavigating property with configurable ShowDelay and HideDelay to prevent flickering for fast navigations.
• Dependency Injection Ready: Seamless integration with Microsoft.Extensions.DependencyInjection, including support for Scoped Services per page.
• Developer Experience: Includes compile-time diagnostics to catch errors early (e.g., missing ViewModels, redundant configurations).

🚀 Getting Started

1. Setup Dependency Injection

Register the core services in your App.axaml.cs:

using NavigationFrame.Avalonia;
using Microsoft.Extensions.DependencyInjection;

public void ConfigureServices(IServiceCollection services)
{
  // 1. Register ViewFactory (Generated or Manual)
  services.AddSingleton<IViewFactory, ViewFactory>(); // See step 2

  // 2. Register NavigationService
  services.AddSingleton<INavigationService, NavigationService>();
  // or, scoped navigation service, treats a page without layout as a `Scope`
  // and all the pages that use a same top-level layout as a `Scope`
  services.AddSingleton<INavigationService, ScopedNavigationService>();

  // 3. Register your ViewModels
  services.AddTransient<HomeViewModel>();
  services.AddTransient<MainLayoutViewModel>();
}

2. Implement ViewFactory

Generated ViewFactory

Create a partial class marked with [ViewFactory]. The source generator will implement the logic to resolve your views.

using NavigationFrame.Avalonia;

namespace MyApp.Services;

[ViewFactory]
public partial class ViewFactory : IViewFactory;

Manual ViewFactory

If you prefer to implement the factory manually, create a class that implements IViewFactory.

3. Initialize Navigation Host

In your window, bind the NavigationService.Content to a ContentControl 's Content.

MainWindow.axaml:

<Window ...>
  <Panel>
    
    <ContentControl Content="{Binding NavigationService.Content}" />

    
    <ProgressBar IsIndeterminate="True"
                  IsVisible="{Binding NavigationService.IsNavigating}"
                  VerticalAlignment="Top"/>
  </Panel>
</Window>

MainWindowViewModel.cs:

public class MainWindowViewModel : ViewModelBase
{
  public INavigationService NavigationService { get; }

  public MainWindowViewModel(INavigationService navService)
  {
    NavigationService = navService;
  }
}

MainWindow.cs:

public class MainWindow : Window
{
  protected override void OnOpened(EventArgs e)
  {
    base.OnOpened(e);
    if(DataContext is MainWindowViewModel { NavigationService: INavigationService navService })
    {
      // Setup default behaviors
      navService.HandleBackwardInput = true; // Alt+Left or MouseBack
      navService.HandleForwardInput = true;  // Alt+Right or MouseForward

      // Navigate to the start page
      _ = navService.NavigateAsync(new LandingPageRoute());
    }
  }
}

📖 Usage Guide

Defining Pages

Mark your Page's Route class (record recommended) with [Route<TPage>]. The framework will generate the implementation of IRoute for it.

// Simple Route
[Route<HomePage>]
public partial record HomePageRoute;

// Route with Parameters
[Route<ProductPage>]
public partial record ProductPageRoute(int Id, string Category);

// Navigate:
await navigator.NavigateAsync(new ProductPageRoute(101, "Electronics"));

Custom Base Route

You can inherit from your own base Route class to add shared properties (e.g., for Menu generation).

public abstract record TabRoute
{
  public abstract string TabName { get; }
  public abstract string Icon { get; }
}

[Route<SettingsPage>]
public partial record SettingsPageRoute : TabRoute
{
  public override string TabName => "Settings";
  public override string Icon => "Gear";
}

[Route<HomePage>]
public partial record HomePageRoute : TabRoute
{
  public override string TabName => "Home";
  public override string Icon => "Home";
}

Navigation Methods

The INavigationService provides a comprehensive set of methods:

• NavigateAsync(route, options): Pushes a new page onto the stack.
• GoBackAsync(): Pops the current page.
• GoForwardAsync(): Navigates to the next page (if any) in the stack.
• RefreshAsync(): Reloads the current page (triggers IPreloadable again).
• GoToAsync(route, options): Navigates to an existing page in the stack if found; otherwise pushes a new one.
  • Matching: You can specify MatchStrategy in NavOptions (ByValue, ByType, or ByReference).
• Post(mode, route, options): Safe way to trigger navigation from within a lifecycle callback (prevents deadlock).

Layouts

Layouts are wrapper controls. Mark them with [Layout] and implement IMountableControl.

[Layout]
public partial class MainLayout : UserControl, IMountableControl
{
    // Return the placeholder where the page content should be placed
    public Control GetMountPoint() => this.FindControl<ContentControl>("Body");
}

Apply a layout to a route:

[Route<HomePage, MainLayout>]
public partial record HomePageRoute;

Nested Layouts

Create a hierarchy by specifying a parent layout for your layout.

// AuthLayout is wrapped by MainLayout
[Layout<MainLayout>]
public partial class AuthLayout : UserControl, IMountableControl;

ViewModel Wiring

The framework infers the ViewModel type using 4 strategies in order:

1. Namespace.HomePage → Namespace.HomeViewModel
2. Namespace.Views.HomePage → Namespace.ViewModels.HomeViewModel
3. Namespace.HomePage → Namespace.ViewModels.HomeViewModel (Appended .ViewModels)
4. Global Search: Any class named HomeViewModel in the assembly.

If inference fails or you want a specific ViewModel:

[Route<MyPage, MyLayout>(DataContext = typeof(CustomViewModel))]
public partial record MyPageRoute;

Navigation Lifecycle & Interfaces

Implement these interfaces in your ViewModel or View to hook into events.

public partial class ProductViewModel : ViewModelBase, IPreloadable, IRequireNavigator,, INavigatingFrom
{
  private INavigator _navigator;

  public void SetNavigator(INavigator navigator)
  {
    _navigator = navigator;
  }

  private Product? _product;
  public async Task PreloadAsync(IRoute route, NavigationMode mode,CancellationToken token)
  {
    // Load data here.
    // This runs on a background thread. Dispatch to UI thread if needed.
    if (route is ProductRoute productRoute)
    {
      // here we store the result in a field and use it until `OnNavigatedToAsync`
      _product = await LoadProductAsync(productRoute.Id, token);
    }
  }

  public async Task<bool> OnNavigatingFromAsync()
  {
    if (HasUnsavedChanges)
    {
      // Show confirmation dialog, return false to cancel navigation
      return await _dialogService.ShowConfirmAsync("Discard changes?");
    }
    return true; // return true to allow navigating away
  }
}

Resource Release

The framework never helps to invoke IDisposable.Dispose(), according to the Microsoft documentation. Who created the instance is responsible for disposing it. The generated IViewFactory implementation uses IServiceProvider to create instances, which means it's up to DI container to manage the lifetime of the instance. If you manually implement IViewFactory, you're responsible for disposing the created instances.

If your component implements IReleaseAware, the framework will call OnReleased() when the component is no longer referenced by the framework. You can use this to release resources, such as closing database connections or disposing of IDisposable resources.

Transitions and Stack Behavior

Control animations and stack manipulation using NavOptions.

var options = new NavOptions
{
  StackBehavior = StackBehaviors.Clear, // Clear history
  Animation = PageAnimations.SlideLeft, // Built-in animation
  IsEphemeral = true, // Skip adding to history
  MatchStrategy = MatchStrategies.ByValue
};
await navigator.NavigateAsync(new HomePageRoute(), options);

💡 Best Practices

1. Avoiding Deadlocks (Re-entrancy)

Never await a navigation method inside a lifecycle callback (like OnNavigatingFromAsync). The navigation queue is blocked waiting for your callback!

Incorrect:

public async Task OnNavigatedFromAsync() {
    await _navigator.GoBackAsync(); // DEADLOCK
}

Correct:

public async Task OnNavigatedFromAsync() {
    _navigator.Post(NavigationMode.GoBack, null); // Safe
}

2. Handling Data Loading

Use IPreloadable for heavy lifting. It runs in parallel with the old page's exit animation. Await the result in OnNavigatedToAsync.

public Task PreloadAsync(IRoute route, NavigationMode mode, CancellationToken t)
{
    // Start loading, return the task.
    // Do NOT await here if you want to block 'OnNavigatedTo' manually later.
    return _service.LoadDataAsync(t);
}

public async Task OnNavigatedToAsync(IRoute route, Task preload, NavigationMode mode)
{
    try
    {
        await preload; // Wait for data, catch exceptions here
        UpdateUi();
    }
    catch (Exception ex)
    {
        ShowError(ex);
    }
}

3. DI Configuration

• Use ScopedNavigationService rather than NavigationService.
• Register ScopedNavigationService as a singleton/transient service, depend on your MainViewModel.
• Register PageViewModel (s) and LayoutViewModel (s) as scoped services.

🛠️ Diagnostics

The library includes Roslyn analyzers to help you keep your code clean and safe: