Skip to main content

WebUIFragmentRoute

Type Alias WebUIFragmentRoute 

Source
pub type WebUIFragmentRoute = WebUiFragmentRoute;

Aliased Type§

pub struct WebUIFragmentRoute {
    pub path: String,
    pub fragment_id: String,
    pub exact: bool,
    pub children: Vec<WebUiFragmentRoute>,
    pub allowed_query: String,
    pub keep_alive: bool,
    pub cache_tags: Vec<String>,
    pub invalidates: Vec<String>,
    pub pending_component: String,
    pub error_component: String,
    pub content_fragment_id: String,
}

Fields§

§path: String§fragment_id: String§exact: bool§children: Vec<WebUiFragmentRoute>

Nested child routes rendered at the component’s .

§allowed_query: String

Comma-separated allowlist of query parameters forwarded as attributes. Empty string means no query params are forwarded (deny-by-default).

§keep_alive: bool

When true, the router preserves the mounted component instance across navigations instead of destroying and recreating it. Opt-in per route.

§cache_tags: Vec<String>

Cache tag templates for this route (e.g. “thread:{threadId}”, “inbox”). Placeholders like {param} are resolved at render time with actual param values.

§invalidates: Vec<String>

Invalidation tag templates (e.g. “inbox”, “thread:{threadId}”). After a mutation action on this route, these tags are auto-invalidated. Supports {param} placeholders resolved at render time.

§pending_component: String

Component tag name for the pending/loading UI (e.g. “mail-skeleton”). Validated at build time — build fails if the component does not exist.

§error_component: String

Component tag name for the error boundary UI (e.g. “error-page”). Validated at build time — build fails if the component does not exist.

§content_fragment_id: String

Optional runtime content authored directly inside this route. The record contains typed boundary references and is rendered only for this route path; nested route declarations remain in children.