RouteNavigator.Core 1.3.1

RouteNavigator.Core

RouteNavigator.Core is a type-safe navigation library for C# applications that simplifies defining and using route-based navigation. It combines an abstraction for navigation (INavigator / AbstractNavigator) with a source generator that turns annotated route definitions into strongly-typed routes and argument objects.

Installation

dotnet add package RouteNavigator.Core

Getting Started

Design your routes

Mark a static partial class with RouteGenerator.Core.RoutesAttribute and declare partial methods that represent your routes.

using RouteGenerator.Core;

[Routes]
public static partial class Routes
{
    public static partial RootNode Home();
    public static partial RouteNode Details(Guid id);
}

Generated Code

The source generator creates strongly-typed argument records and route factories.

public record DetailsArgs(global::System.Guid Id) : global::RouteNavigator.Core.IRouteArgs
{
    public static DetailsArgs FromDictionary(global::System.Collections.Generic.Dictionary<string, object> dictionary)
    {
        var id = (global::System.Guid)dictionary[nameof(Id)];
        return new DetailsArgs(id);
    }

    public global::System.Collections.Generic.Dictionary<string, object?> ToDictionary()
    {
        return new global::System.Collections.Generic.Dictionary<string, object?>
        {
            [nameof(Id)] = this.Id
        };
    }
}

public record HomeArgs() : global::RouteNavigator.Core.IRouteArgs
{
    public static HomeArgs FromDictionary(global::System.Collections.Generic.Dictionary<string, object> dictionary)
    {
        return new HomeArgs();
    }

    public global::System.Collections.Generic.Dictionary<string, object?> ToDictionary()
    {
        return new global::System.Collections.Generic.Dictionary<string, object?>
        {
        };
    }
}

public static partial class Routes
{
    public static class Values
    {
        public const string HomeRoute = "Home";
        public const string DetailsRoute = "Details";
    }

    public static partial global::RouteNavigator.Core.RootNode Home()
    {
        return new global::RouteNavigator.Core.RootNode(Values.HomeRoute, new HomeArgs());
    }

    public static partial global::RouteNavigator.Core.RouteNode Details(global::System.Guid id)
    {
        return new global::RouteNavigator.Core.RouteNode(Values.DetailsRoute, new DetailsArgs(id));
    }
}

Now you can call

var home = Routes.Home();
var details = Routes.Details(guid);

Navigation

To integrate with your application, you can implement the INavigator or IAsyncNavigator interfaces, or inherit from AbstractNavigator or AbstractAsyncNavigator.

INavigator navigator = ...;
navigator.NavigateTo(Routes.Home);

You can also pass multiple routes as a more consise navigation stack

navigator.NavigateTo(Routes.Home, Routes.Details(guid));

You can also define root routes, with which should replace the previous navigation stack.

public static partial RootNode MainRoute()
{
    return new RootNode(Values.RootRoute, new RootArgs());
}