Method Route

Namespace

Velvet

Assembly

Velvet.Docs.dll

Route(string?, ComponentNode?, string?, Func<RouteLoaderContext, CancellationToken, VelvetTask<object>>?, LoaderMode, ComponentNode?, RouteDefinition[]?, string?, Func<RouteLoaderContext, string>?, bool, Func<RouteActionContext, CancellationToken, VelvetTask<object>>?, string?, object?)

Path-based route definition. Declaratively expresses Velvet Router's nested routes and Loaders.

public static RouteDefinition Route(string? path, ComponentNode? element = null, string? scopeId = null, Func<RouteLoaderContext, CancellationToken, VelvetTask<object>>? loader = null, LoaderMode loaderMode = LoaderMode.Await, ComponentNode? errorElement = null, RouteDefinition[]? children = null, string? redirectTo = null, Func<RouteLoaderContext, string>? guard = null, bool caseSensitive = false, Func<RouteActionContext, CancellationToken, VelvetTask<object>>? action = null, string? id = null, object? handle = null)

Parameters

path string

URL path pattern for matching. Must not be null.

element ComponentNode

Component rendered when the route matches. Mutually exclusive with redirectTo.

scopeId string

Optional VContainer scope ID associated with this route.

loader Func<RouteLoaderContext, CancellationToken, VelvetTask<object>>

Async loader invoked on entry; result is exposed via Loader hook.

loaderMode LoaderMode

Whether the navigation waits for the loader before committing (Await) or commits immediately and streams the result in (Suspend). See LoaderMode.

errorElement ComponentNode

Component rendered in place of element when this route's loader fails, or a descendant route's does with no nearer errorElement.

children RouteDefinition[]

Nested child route definitions.

redirectTo string

Path to redirect to. Mutually exclusive with element and guard.

guard Func<RouteLoaderContext, string>

Pass-through guard returning a redirect path or null. Cannot be combined with redirectTo.

caseSensitive bool

When true, literal path segments match case-sensitively. Defaults to false (case-insensitive).

action Func<RouteActionContext, CancellationToken, VelvetTask<object>>

Called for a submission other than get that targets this route; its result is exposed via Hooks.UseActionData.

id string

Identifies the route among the matches; see Id.

handle object

Data the route carries for Hooks.UseMatches; see Handle.

Returns

RouteDefinition

The created RouteDefinition.

Exceptions

ArgumentOutOfRangeException

loaderMode names no member of LoaderMode.