# RouteInstance

A [route handler](/docs/platform/lwr/guide/lwr-route-handler-modules.md) receives a `RouteInstance` when a new client-side navigation event occurs. `RouteInstance` contains location information passed to [`RouteHandler.update`](/docs/platform/lwr/references/csr-reference/update.md). The route handler uses the `RouteInstance` to determine which view to show.

## Syntax

```sfdocs-code {"lang":"javascript", "title": "", "src": "" }
interface RouteInstance {
  id: string; // RouteDefinition.id
  pageReference: PageReference;
  label: string;
}
```

## Properties

| Property        | Type                   | Required/Optional | Description                                                                                                          |
| --------------- | ---------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id`            | String                 | Required          | The unique identifier for the [`RouteDefinition`](/docs/platform/lwr/references/csr-reference/routedefinition.md).   |
| `pageReference` | `PageReference` object | Required          | The [`PageReference` object](/docs/platform/lwr/references/csr-reference/pagereference.md) for the navigation event. |

## Example

```sfdocs-code {"lang":"javascript", "title": "Example RouteInstance", "src": "" }
{
    id: '1',
    pageReference: {
        type: 'animal',
        attributes: { pageName: 'animal' },
        state: {},
    },
},
```

**See Also**

- [Route Handler Modules](/docs/platform/lwr/guide/lwr-route-handler-modules.md#3-the-router-passes-routeinstance-to-routehandlerupdate)