# Broute (Component)

`Bit.Brouter.Broute` - inherits `ComponentBase` - implements `IComponent`, `IDisposable`, `IHandleAfterRender`, `IHandleEvent`

Declares a single route inside a Broute.Brouter.

## Parameter

- **ChildContent** : `RenderFragment` - Child routes (used for nesting).
- **Component** : `Type` - The component type to render when this route matches.
- **Content** : `RenderFragment<BrouterRouteParameters>` - A render fragment to render when this route matches. The argument carries the route parameters.
- **ErrorContent** : `RenderFragment<BrouterErrorContext>` - Error UI for this route. When a commit-phase failure occurs (typically a Broute.Loader in the matched chain throwing), the nearest ErrorContent - walking from the failed route up through its ancestors - renders in place of the routed content, while ancestor layouts above the boundary keep rendering normally. The fragment receives a BrouterErrorContext with the exception, the location, and a RetryAsync() that re-runs the navigation. When no route in the chain declares one, the failure bubbles to Brouter.ErrorContent. The global IBrouter.OnError hook fires either way.
- **Group** : `bool` = `false` - Marks this as a pathless grouping route: it contributes no URL segments and never matches by itself, existing purely to attach shared behavior - a Broute.Guard, Broute.LeaveGuard, Broute.Loader, Broute.ErrorContent or a layout Broute.Content (with a BrouterOutlet) - to the routes declared in its Broute.ChildContent. Children inherit the surrounding path as if the group weren't there. Mirrors SvelteKit's (group) directories and TanStack Router's pathless layout routes. A group must not declare a Broute.Path.
- **Guard** : `Func<BrouterNavigationContext, ValueTask>` - Async guard. Use ctx.Cancel() or ctx.Redirect("/login") to deny. Inspired by Vue Router's beforeEnter and Angular's CanActivate.
- **KeepAlive** : `bool` = `false` - When true, this route's rendered content is kept mounted (hidden) after the user navigates away, so returning to it restores the exact component state - scroll inside widgets, form input, expanded panels - instead of recreating the component. The Angular RouteReuseStrategy / Vue KeepAlive idea, scoped per route. The preserved content lives inside a <div hidden> wrapper while inactive, so it costs memory and (hidden) DOM for as long as its hosting layout stays mounted; state survives sibling navigations under the same layout, not the layout's own unmount. Opt-in per route.
- **KeepAliveMax** : `int?` - Retained-instance budget for this Broute.KeepAlive route. At the default of 1 (or when unset and BrouterOptions.DefaultKeepAliveMax is 1) the route keeps a single live instance that re-binds when its parameter values change - state carries across parameter changes. Above 1, instances are kept per matched parameter values: visiting /item/1 then /item/2 mounts two separate instances, and returning to /item/1 resumes its exact state. When the budget is exceeded the least-recently-used hidden instance is evicted (disposed). The key is built from the route's template parameter values only - the query string is deliberately not part of it, so ?tab=2 variations share one instance. No effect unless Broute.KeepAlive is set; values below 1 act as 1.
- **LeaveGuard** : `Func<BrouterNavigationContext, ValueTask>` - Async leave guard: runs when a navigation would deactivate this route (it is part of the currently rendered chain but not of the new one), before OnNavigating and any enter Broute.Guards, leaf to root. ctx.Cancel() / ctx.Redirect(...) are preventive - the URL never changes on a cancelled leave, enabling real "unsaved changes" prompts per route. A navigation that keeps this route matched (e.g. only a parameter or a descendant changed) does not fire it. During the leave call, ctx.Route is the route being left. Inspired by Vue Router's beforeRouteLeave and Angular's CanDeactivate.
- **Loader** : `Func<BrouterNavigationContext, ValueTask<object>>` - Async data loader. Runs after the route matches and guards pass, before render. The result is exposed to the rendered content as an unnamed cascading BrouterRouteData (matched by type) with typed Get<T>/TryGet<T> accessors. In a nested chain, loaders run sequentially root -> leaf by default (each parent's loader completes before its child's starts); set Brouter.ParallelLoaders to run independent loaders concurrently instead. Inspired by React Router v6's loader and Angular's Resolve.
- **Meta** : `object` - Optional metadata. Exposed to the rendered content as an unnamed cascading BrouterRouteMeta (matched by type) with typed Get<T>/TryGet<T> accessors.
- **Name** : `string` - Optional unique name for this route. Used by IBrouter.NavigateToName and IBrouter.ResolveUrl.
- **Path** : `string` = `""` **(required)** - The route path to match. Supports literal segments, parameter segments, constraints and wildcards. E.g. "/users/{id:int}", "/files/{**path}", "/posts/{slug?}". For nested (child) routes, an empty string matches the parent path exactly (index route).
- **RedirectTo** : `string` - When set, navigating to this route redirects to the given URL instead of running loaders or rendering. Guards (on this route and its ancestors) still run first, so a guard may cancel the navigation or redirect elsewhere; only when guards pass is the redirect to Broute.RedirectTo performed.
- **Routes** : `RenderFragment` - Alias for Broute.ChildContent. When another template (Broute.Content, Broute.ErrorContent, ...) forces the child fragments to be spelled out explicitly, <Routes> states the intent better than <ChildContent>. Set one or the other, not both.
- **StaleTime** : `TimeSpan?` - Freshness window for this route's Broute.Loader result, enabling the router's stale-while-revalidate cache: a navigation (or Back/Forward) to a URL whose cached result is younger than this skips the loader entirely; an older-but-not-garbage-collected result is served per BrouterOptions.StaleReloadMode (rendered immediately with a background refresh by default). Null (the default) falls back to BrouterOptions.DefaultLoaderStaleTime, which itself defaults to no caching. Cache entries key on the full URL (path + query), so different parameters cache separately. Inspired by TanStack Router's staleTime.

## Method

- **Dispose**() : `void`