Client router

API references extracted from the Gracile code base.
Examples, functions, classes, constants, type declarations…

Function: createRouter()

function createRouter(config?): GracileRouter;

Client-side routing that takes over the SSRed markup and browser navigation.

Parameters

Parameter	Type	Description
`config`?	`GracileRouterConfig`	Router instance configuration.

Returns

GracileRouter

The client router as an observable or controllable event target.

Version

experimental

Example

./src/client-router.ts

import { createRouterfunction createRouter(config?: GracileRouterConfig): GracileRouterClient-side routing that takes over the SSRed markup and browser navigation.
@paramconfig Router instance configuration.@paramconfig.plugins Router plugins.@paramconfig.routes Additional routes.@versionexperimental@example`./src/client-router.ts`
```js
import { createRouter } from '@gracile-labs/client-router/create';

export const router = createRouter();
```@returnsThe client router as an observable or controllable event target. } from '@gracile-labs/client-router/create';

export const routerconst router: GracileRouter = createRouterfunction createRouter(config?: GracileRouterConfig): GracileRouterClient-side routing that takes over the SSRed markup and browser navigation.
@paramconfig Router instance configuration.@paramconfig.plugins Router plugins.@paramconfig.routes Additional routes.@versionexperimental@example`./src/client-router.ts`
```js
import { createRouter } from '@gracile-labs/client-router/create';

export const router = createRouter();
```@returnsThe client router as an observable or controllable event target.();

Defined in

create.ts:92