Interface RouterApi

Public navigation API for page-level routing.

interface RouterApi {
    back(): void;
    canGoBack(): boolean;
    currentRoute(): RouteLocation;
    history(): readonly Readonly<{ id: string; params: RouteParams }>[];
    navigate(routeId: string, params?: Readonly<Record<string, string>>): void;
    replace(routeId: string, params?: Readonly<Record<string, string>>): void;
}

Index

Methods

back canGoBack currentRoute history navigate replace

Methods

back

back(): void
Pop one entry from history when possible.

Returns void
- Defined in core/src/router/types.ts:28

canGoBack

canGoBack(): boolean
True when back() can pop an entry.

Returns boolean
- Defined in core/src/router/types.ts:32

currentRoute

currentRoute(): RouteLocation
Get the current route location.

Returns RouteLocation
- Defined in core/src/router/types.ts:30

history

history(): readonly Readonly<{ id: string; params: RouteParams }>[]
Ordered history from oldest entry to current entry.

Returns readonly Readonly<{ id: string; params: RouteParams }>[]
- Defined in core/src/router/types.ts:34

navigate

navigate(routeId: string, params?: Readonly<Record<string, string>>): void
Push a route on top of history.
Parameters
- routeId: string
- Optionalparams: Readonly<Record<string, string>>
Returns void
- Defined in core/src/router/types.ts:24

replace

replace(routeId: string, params?: Readonly<Record<string, string>>): void
Replace the current route entry without growing history.
Parameters
- routeId: string
- Optionalparams: Readonly<Record<string, string>>
Returns void
- Defined in core/src/router/types.ts:26