ThopDev.Generator.Blazor.Routes 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package ThopDev.Generator.Blazor.Routes --version 1.0.0
NuGet\Install-Package ThopDev.Generator.Blazor.Routes -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ThopDev.Generator.Blazor.Routes" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ThopDev.Generator.Blazor.Routes --version 1.0.0
#r "nuget: ThopDev.Generator.Blazor.Routes, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ThopDev.Generator.Blazor.Routes as a Cake Addin
#addin nuget:?package=ThopDev.Generator.Blazor.Routes&version=1.0.0

// Install ThopDev.Generator.Blazor.Routes as a Cake Tool
#tool nuget:?package=ThopDev.Generator.Blazor.Routes&version=1.0.0

Banner

ThopDev.SourceGenerator.Blazor.Routes

This package uses source generation to create strongly typed methods to generate your routes. You simply define your routes and the function to generate your string is generated!

Nuget (with prereleases)

Warning!

This package is still in beta! I'm working hard to improve this package but it could still contains bugs. If you find any please contact me, so we can fix it!

Usage

Install the package

dotnet add package ThopDev.Generator.Blazor.Routes

Add using to your class

@using ThopDev.Generator.Blazor.Routes

To start, define the routes on the code behind component. Currently no support for .razor pages. Example:

[Route("/users/{id:int}")]
[Route("/users/{id:int}/name/{name}")]
public class UserPage {
    [SupplyParameterFromQuery] public string SearchString { get; set; }
    [SupplyParameterFromQuery(Name = "AnotherName")] public int Age { get; set; }
}

This will provide you with the following function on the NavigationFactory

INavigationFactory factory = new NavigationFactory();

// /users/5
string user = factory.Users().WithId(5).ToRoute();

// /users/12/name/test?SearchString=test&anotherName=42
string userWithName = factory.Users().WithId(12).Name().WithName("test").ToRoute(searchString: "Hello", anotherName: 42);

Examples

Route Code Generates
/ factory.ToRoute(); /
/users factory.Users().ToRoute(); /users
/users/{id:int} factory.Users().WithId(5).ToRoute(); /users/5
/users/{id:int}/name/{name} factory.Users().WithId(12).Name().WithName("test").ToRoute(); /users/12/name/test
/groups/roles/name factory.Groups().Roles().Name().ToRoute(); /groups/roles/name
/groups/foo factory.Groups().Foo().ToRoute(); /groups/foo

Limitations

In .Net 6 blazor uses source generation to code compile the .razor pages. This makes it harder to analyze it, for this reason, we can't create the code for those yet. To bypass this you can add the following code to your csproj:


<PropertyGroup>
  <UseRazorSourceGenerator>false</UseRazorSourceGenerator>
</PropertyGroup> 

Feedback and suggestions

Any suggestions, feedback or bugs reports are appreciated and can be done though: feedback

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 437 7/29/2022
1.0.0 377 6/23/2022
0.0.9 379 6/23/2022
0.0.8 369 6/14/2022
0.0.7 369 6/11/2022
0.0.6 368 6/11/2022
0.0.5 362 6/11/2022
0.0.4 393 6/10/2022
0.0.3 399 6/10/2022