[**@jupyterlite**](../../../README.md)

***

[@jupyterlite](../../../README.md) / [@jupyterlite/application](../README.md) / ILiteRouter

# Interface: ILiteRouter

Defined in: [packages/application/src/router.ts:27](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/application/src/router.ts#L27)

An interface for the custom URL router provider.

Provides IRouter, plus the additional methods to transform `/path/`-based routes

## Extends

- `IRouter`

## Properties

### addTransformer()

> **addTransformer**: (`transformer`) => `void`

Defined in: [packages/application/src/router.ts:31](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/application/src/router.ts#L31)

Add a URL transformer

#### Parameters

##### transformer

[`IURLTransformer`](IURLTransformer.md)

#### Returns

`void`

***

### base

> `readonly` **base**: `string`

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:71

The base URL for the router.

#### Inherited from

`IRouter.base`

***

### commands

> `readonly` **commands**: `CommandRegistry`

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:75

The command registry used by the router.

#### Inherited from

`IRouter.commands`

***

### current

> `readonly` **current**: `ILocation`

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:79

The parsed current URL of the application.

#### Inherited from

`IRouter.current`

***

### routed

> `readonly` **routed**: `ISignal`\<`IRouter`, `ILocation`\>

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:83

A signal emitted when the router routes a route.

#### Inherited from

`IRouter.routed`

***

### stop

> `readonly` **stop**: `Token`\<`void`\>

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:88

If a matching rule's command resolves with the `stop` token during routing,
no further matches will execute.

#### Inherited from

`IRouter.stop`

## Methods

### navigate()

> **navigate**(`path`, `options?`): `void`

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:96

Navigate to a new path within the application.

#### Parameters

##### path

`string`

The new path or empty string if redirecting to root.

##### options?

`INavOptions`

The navigation options.

#### Returns

`void`

#### Inherited from

`IRouter.navigate`

***

### register()

> **register**(`options`): `IDisposable`

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:104

Register a rule that maps a path pattern to a command.

#### Parameters

##### options

`IRegisterOptions`

The route registration options.

#### Returns

`IDisposable`

A disposable that removes the registered rule from the router.

#### Inherited from

`IRouter.register`

***

### reload()

> **reload**(): `void`

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:108

Cause a hard reload of the document.

#### Returns

`void`

#### Inherited from

`IRouter.reload`

***

### route()

> **route**(`url`): `void`

Defined in: node\_modules/@jupyterlab/application/lib/tokens.d.ts:118

Route a specific path to an action.

#### Parameters

##### url

`string`

The URL string that will be routed.

#### Notes
If a pattern is matched, its command will be invoked with arguments that
match the `IRouter.ILocation` interface.

#### Returns

`void`

#### Inherited from

`IRouter.route`