Modrich.Navigation.Abstractions 0.1.0

Modrich.Navigation.Abstractions

Navigation + layout contracts for Modrich UI modules on .NET 10. UI modules (.Web RCL projects) reference this without pulling EF Core — the package is intentionally tiny.

What's in the box

• IMainMenuProvider — contributes top-level entries (NavItem) to the host's main left navigation.
• IModuleMenuProvider — contributes a module's inner tab bar; activates when the request URL's first segment matches RoutePrefix. Carries ResourceType so the layout can localize MenuItem.Title via IStringLocalizer.
• JsonModuleMenuProvider — IModuleMenuProvider backed by a JSON stream; ships with a FromEmbeddedResource(...) helper for loading the JSON from the module's own assembly.
• NavItem — Title, Href, optional Icon, Group, Order, Roles, Permissions.
• MenuItem — supports leaves (Href) and parents (MenuItems), plus Icon, Permission, Order.

Install

dotnet add package Modrich.Navigation.Abstractions

Usage — main-menu entry per module

using Modrich.Navigation;

public sealed class OrdersMainMenuProvider : IMainMenuProvider
{
    public IEnumerable<NavItem> GetNavItems() =>
    [
        new NavItem
        {
            Title       = nameof(Strings.Orders),
            Href        = "/orders",
            Icon        = "shopping-cart",
            Group       = "Sales",
            Order       = 100,
            Permissions = ["Module.Orders.Access"],
        }
    ];
}

Register from the module:

public void RegisterAppDependencies(IServiceCollection services, IConfiguration configuration, string? apiBaseUrl = null)
{
    services.AddSingleton<IMainMenuProvider, OrdersMainMenuProvider>();
}

The host enumerates every registered IMainMenuProvider, filters by Permissions/Roles, orders by Group then Order, and renders the result in its shell.

Usage — inner module menu from embedded JSON

menu.json in the module assembly, marked as EmbeddedResource:

[
  { "Title": "Overview",  "Href": "/orders",          "Icon": "list",  "Order": 10 },
  { "Title": "New order", "Href": "/orders/new",      "Icon": "plus",  "Order": 20, "Permission": "Orders.Edit" },
  {
    "Title": "Reports",
    "Order": 30,
    "MenuItems": [
      { "Title": "Daily",   "Href": "/orders/reports/daily"   },
      { "Title": "Monthly", "Href": "/orders/reports/monthly" }
    ]
  }
]

Register the provider:

services.AddSingleton<IModuleMenuProvider>(_ =>
    JsonModuleMenuProvider.FromEmbeddedResource(
        routePrefix:  "orders",
        resourceType: typeof(Strings),
        assembly:     typeof(OrdersAppModule).Assembly,
        resourceName: "Acme.Orders.Web.menu.json"));

The host activates this provider when the URL begins with /orders, and resolves MenuItem.Title via IStringLocalizer.Create(resourceType).

Related packages

• Modrich.Abstractions — LayoutSections, IModuleLayoutWidget for slotted widgets.
• Modrich.Sdk.Web — meta-package for .Web modules; pulls this in.

Versioning

Strict semver — see Modrich.Abstractions. EnablePackageValidation is on.

License

MIT.