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

***

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

# Class: LiteRouter

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

A custom router that extends the standard Router with URL transformation capabilities

## Extends

- `Router`

## Implements

- [`ILiteRouter`](../interfaces/ILiteRouter.md)

## Constructors

### Constructor

> **new LiteRouter**(`options`): `LiteRouter`

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

#### Parameters

##### options

`IOptions`

#### Returns

`LiteRouter`

#### Overrides

`Router.constructor`

## Properties

### base

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

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:17

The base URL for the router.

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`base`](../interfaces/ILiteRouter.md#base)

#### Inherited from

`Router.base`

***

### commands

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

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:21

The command registry used by the router.

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`commands`](../interfaces/ILiteRouter.md#commands)

#### Inherited from

`Router.commands`

***

### stop

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

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:34

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

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`stop`](../interfaces/ILiteRouter.md#stop)

#### Inherited from

`Router.stop`

## Accessors

### current

#### Get Signature

> **get** **current**(): `ILocation`

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:25

Returns the parsed current URL of the application.

##### Returns

`ILocation`

The parsed current URL of the application.

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`current`](../interfaces/ILiteRouter.md#current)

#### Inherited from

`Router.current`

***

### routed

#### Get Signature

> **get** **routed**(): `ISignal`\<`this`, `ILocation`\>

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:29

A signal emitted when the router routes a route.

##### Returns

`ISignal`\<`this`, `ILocation`\>

A signal emitted when the router routes a route.

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`routed`](../interfaces/ILiteRouter.md#routed)

#### Inherited from

`Router.routed`

## Methods

### addTransformer()

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

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

Add a URL transformer

#### Parameters

##### transformer

[`IURLTransformer`](../interfaces/IURLTransformer.md)

#### Returns

`void`

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`addTransformer`](../interfaces/ILiteRouter.md#addtransformer)

***

### navigate()

> **navigate**(`url`, `options`): `void`

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

Navigate to a new path within the application.

#### Parameters

##### url

`string`

The new path or empty string if redirecting to root.

##### options

The navigation options.

###### hard?

`boolean`

###### skipRouting?

`boolean`

#### Returns

`void`

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`navigate`](../interfaces/ILiteRouter.md#navigate)

#### Overrides

`Router.navigate`

***

### register()

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

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:50

Register to route 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.

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`register`](../interfaces/ILiteRouter.md#register)

#### Inherited from

`Router.register`

***

### reload()

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

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:54

Cause a hard reload of the document.

#### Returns

`void`

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`reload`](../interfaces/ILiteRouter.md#reload)

#### Inherited from

`Router.reload`

***

### route()

> **route**(): `Promise`\<`void`\>

Defined in: node\_modules/@jupyterlab/application/lib/router.d.ts:62

Route a specific path to an action.

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

#### Returns

`Promise`\<`void`\>

#### Implementation of

[`ILiteRouter`](../interfaces/ILiteRouter.md).[`route`](../interfaces/ILiteRouter.md#route)

#### Inherited from

`Router.route`