Skip to content

useNavigation ​

Overview ​

Composition function to provide navigation data for a given configuration.

Signature ​

useNavigation(userConfig)

Parameters ​

NameTypeRequiredDescription
userConfigobjectyesThe user configuration.

userConfig Properties ​

NameTypeRequiredDefaultDescription
appsobject[]The apps to build navigation for.
customRoutesobject[]Custom routes to add to the navigation.

Returns ​

- An object containing reactive navigation data.

Source ​

client/lib/use/useNavigation.js:58