Singulink.UI.Navigation.WinUI 3.0.1

Singulink UI Toolkit

UI Toolkit is a complete solution for building modern and maintainable user interfaces with complex deep-linked navigation in XAML-based applications. It places a strong emphasis on separation of concerns and full testability of view models. We are confident that you will not want to use anything else once you try it out! It is currently focused on WinUI and Uno-based applications but some components are UI framework-agnostic. Details of each component are provided below.

Library	Status	Package
Singulink.UI.Navigation	Public
Singulink.UI.Navigation.WinUI	Public
Singulink.UI.Tasks	Public
Singulink.UI.Xaml.WinUI	Public

Libraries may be in any of the following states:

• Internal: Source code (and possibly a nuget package) is available to the public but the library is intended to be used internally until further development.
• Preview: The library is available for public preview but the APIs may not be fully documented and the API surface is subject to change without notice.
• Public: The library is intended for public use with a fully documented and stable API surface.

You are free to use any libraries or code in this repository that you find useful and feedback/contributions are welcome regardless of library state.

About Singulink

We are a small team of engineers and designers dedicated to building beautiful, functional, and well-engineered software solutions. We offer very competitive rates as well as fixed-price contracts and welcome inquiries to discuss any custom development / project support needs you may have.

This package is part of our Singulink Libraries collection. Visit https://github.com/Singulink to see our full list of publicly available libraries and other open-source projects.

Components

Singulink.UI.Navigation

Key Features:

✔️ First-class asynchronous navigation with automatic busy-state management
✔️ Strongly-typed and compile-time checked routes and route parameters to make mistakes almost impossible - no more magic strings!
✔️ Comprehensive deep-linking support with automatic route parameter parsing and validation
✔️ Compatible with all major MVVM frameworks
✔️ Single window or multi-window app support with an arbitrary level of view nesting
✔️ Intuitive, straightforward and foolproof support for content dialogs / message dialogs / nested dialogs
✔️ Just as easy to use with or without a DI container (we prefer not to use one at all with this library!)
✔️ Full integration with Singulink.UI.Tasks (see below) for simple and easy management of busy-state while long running operations are executing on pages or dialogs

The base library is not tied to any particular UI framework and can be referenced from framework-agnostic view model projects, but currently only WinUI/Uno-specific implementations of the base library types are provided via the Singulink.UI.Navigation.WinUI package to do the actual navigation and routing in the UI app layer. We plan to add more UI framework implementations (probably WPF and Avalonia initially) soon.

Stay tuned, additional documentation and examples are also coming soon! You are welcome to have a look at the Playground project to get an idea of how it works for now.

Supported Platforms: .NET 8.0+, WinUI (WinAppSDK 1.7+), Uno Platform 6.0+

Singulink.UI.Xaml.WinUI

Contains useful XAML extensions (behaviors, converters, static convert methods for use with x:Bind) for WinUI and Uno-based applications.

Here is a small sampling of the huge collection of static convert methods available:

xmlns:c="using:Singulink.UI.Xaml.Converters"

IsEnabled="{x:Bind c:If.Zero(Model.Items.Count)}"
IsEnabled="{x:Bind c:If.NotZero(Model.Items.Count)}"
IsEnabled="{x:Bind c:If.Null(Model.Item)}"
IsEnabled="{x:Bind c:If.NotNullOrWhiteSpace(Model.Name)}"
IsEnabled="{x:Bind c:If.NotDefault(Model.SomeEnumValue)}"

Visibility="{x:Bind c:Visible.IfStringEqualsAny(Model.EnumValue, 'EnumName1', 'EnumName2')}"
Visibility="{x:Bind c:Visible.IfFocused(SomeOtherControl.FocusState)}"
Visibility="{x:Bind c:Visible.IfFalse(Model.Hide)}"

Opacity="{x:Bind c:Opaque.IfTrue(Model.ShowValue)}"}

Uri="{x:Bind c:Uri.Email(Model.EmailString)}"
Uri="{x:Bind c:Uri.Phone(Model.PhoneString)}"
Uri="{x:Bind c:Uri.Website(Model.WebsiteString)}"

Supported Platforms: .NET 8.0+, WinUI (WinAppSDK 1.7+), Uno Platform 6.0+

Singulink.UI.Tasks

Provides a DI-friendly and UI framework-agnostic task runner/dispatcher with integrated support for managing UI busy-state while tasks are running. Supports running "fire-and-forget" tasks that can be tracked and fully tested. Inspired by AmbientTasks (thanks @jnm2!).

TaskRunner is fully integrated with Singulink.UI.Navigation. See above for documentation on how it should be used in that scenario.

Here is an example of usage when TaskRunner is not used with the navigation framework:

public class App
{
  public static ITaskRunner TaskRunner { get; private set; }

  public void OnAppStart()
  {
    // Assign to a singleton you can pass around, or register with your DI container here

    TaskRunner = new TaskRunner(
      busy => YourRootControl.IsEnabled = !busy);
  }
}

public class YourViewModel(ITaskRunner taskRunner)
{
  public ObservableCollection<Item> Items { get; } = [];

  // Fire and forget example:

  public void OnNavigatedTo()
  {
    // YourRootControl.IsEnabled will be false while this runs

    taskRunner.RunAndForget(setBusy: true, async () =>
    {
      var items = await LoadItemsAsync();

      foreach (var item in items)
      {
        Items.Add(item);
      }
    });
  }

  // Command that runs a task which should indicate busy state example:

  [RelayCommand]
  public async Task SaveAsync()
  {
    // YourRootControl.IsEnabled will be false while this runs
    await taskRunner.RunAsBusyAsync(async () => await ApiClient.SaveAsync());
  }
}

Our philosophy is that testing view models without a proper synchronization context that simulates a main UI thread is asking for trouble, so TaskRunner requires one. The AsyncEx.Context library has a perfect AsyncContext class that can be used for this purpose. Your test would then look something like this:

[TestClass]
public class YourViewModelTests
{
  [TestMethod]
  public void TestLoadsItemsAsync()
  {
    AsyncContext.Run(async () =>
    {
      var taskRunner = new TaskRunner();

      var vm = new YourViewModel(taskRunner);
      vm.OnNavigatedTo();

      // Wait for all busy tasks to complete
      await taskRunner.WaitForIdleAsync(waitForNonBusyTasks: false);

      Assert.AreEqual(3, vm.Items.Count);
    });
  }
}

Supported Platforms: .NET 8.0+, any UI framework (i.e. UWP/WinUI, Uno Platform, Avalonia, WPF, etc)

Further Reading

You can view API documentation on the project documentation site.