---
url: "https://vueda.dev/v3/reference/api/js/use/useNavigation/functions/useNavigation.md"
title: "useNavigation"
---

# useNavigation

## Overview

Composition function to provide navigation data for a given configuration.

## Signature

`useNavigation(userConfig)`

### Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| <span id="param-userConfig">userConfig</span> | `object` | yes | The user configuration. |

#### userConfig Properties

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="param-userConfig-apps">apps</span> | `object[]` |  |  | The apps to build navigation for. |
| <span id="param-userConfig-customRoutes">customRoutes</span> | `object[]` |  |  | Custom routes to add to the navigation. |

### Returns

`- An object containing reactive navigation data.`

## Source

`client/lib/use/useNavigation.js:58`