Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/suiram1701/blazorroutesgenerator

A code generator for Blazor that generates hard-coded routes builders for routable components.
https://github.com/suiram1701/blazorroutesgenerator

asp-net-core blazor blazor-routing blazor-webassembly code-generator

Last synced: 4 months ago
JSON representation

A code generator for Blazor that generates hard-coded routes builders for routable components.

Awesome Lists containing this project

README 

        
# BlazorRoutesGenerator ![NuGet Version](https://img.shields.io/nuget/vpre/Suiram1.BlazorRoutesGenerator) ![NuGet Downloads](https://img.shields.io/nuget/dt/Suiram1.BlazorRoutesGenerator)



This library provides a code generator that detects routable components in .cs or in .razor files and create har-coded routes based on them.

The code generator will be recognize [@page-directive](https://learn.microsoft.com/aspnet/core/mvc/views/razor#page) in .razor files and the [[Route("/")]](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.components.routeattribute)-attribute in .cs files.\

For each route defined by one of the mentioned ways the generator will generate two method. The first one will generate an relative uri to the page and the second one is an extensions of [NavigationManager](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.components.navigationmanager) that will navigate to this page. The extension has the same method name as the uri creator method but with the prefix NavigateTo.



## Route parameters



The generated methods supports route parameters of every by ASP.NET Core [supported route parameter](https://learn.microsoft.com/aspnet/core/blazor/fundamentals/routing#route-constraints). A recognized route parameters gets in both methods of his route a parameter were you can specify this parameter.



## Query parameters



The generated methods supports query parameter as well. Query parameters of a page are recognized when a property has the [[SupplyParameterFromQuery]](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.components.supplyparameterfromqueryattribute)-attribute.\

The name of the query parameter can provided using the [Name](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.components.supplyparameterfromqueryattribute.name#microsoft-aspnetcore-components-supplyparameterfromqueryattribute-name)-property of the attribute. If this property isn't specified the name of the property will be used.\

The type of the query parameter is determined by the type of the property. Complex query parameters won't get serialized and only the [ToString](https://learn.microsoft.com/dotnet/api/system.object.tostring) get called.



## Generated methods



Every method generated is inside of the static class named __Routes__ inside the application root namespace. The name of the methods is determined by the class/file name. If two classes/files has the same names as little as possible from the namespace is used to clearly identify the page.\

For example the page *../Pages/Index.razor* has the method name __Index__. But when there are two pages *../Pages/SectionA/Index.razor* and *../Pages/SectionB/Index.razor* the method names of these pages are __SectionAIndex__ and __SectionBIndex__. In .razor files is for that purpose also the [@namespace-directive](https://learn.microsoft.com/aspnet/core/mvc/views/razor#namespace) supported.



## Limitations



Query parameters are __only in .cs files__ supported. Inside of .razor files they won't be detected. In case that you want to use .razor files for HTML + CS and query parameters you can define the page in partial classes ([more about that here](https://www.pragimtech.com/blog/blazor/Split-razor-component/)) and define the query parameters there.