# useNavigationPath
# useNavigationPath($store, $route, expectedLevel)
Methods to "dispatch" a NavigationPath in the $store.
When expectedLevel is null or undefined it will automatically generate a NavigationPath until the previous entity in the $route (so it will not include the current entity)
Kind: global function
| Param | Type | Default | Description |
|---|---|---|---|
| $store | |||
| $route | |||
| expectedLevel | string | null | null | Generate a navigationPath for a specific entity |
- useNavigationPath($store, $route, expectedLevel)
- ~currentLevel :
ComputedRef.<string> - ~expectedSlugs :
ComputedRef.<array> - ~navigationPath :
ComputedRef.<array> - ~setupNavigationPath(payload)
- ~currentLevel :
# useNavigationPath~currentLevel : ComputedRef.<string>
Current level can either be influenced by the signature, or it will use the defaultLevel, which is the current entity!
Kind: inner constant of useNavigationPath
# useNavigationPath~expectedSlugs : ComputedRef.<array>
Returns all slugs, until the currentLevelIndex
It will not include the current level!
Kind: inner constant of useNavigationPath
# useNavigationPath~navigationPath : ComputedRef.<array>
A generated payload based on the given level. It generates a path UNTIL the previous entity. So in other words, it does NOT include the current entity!
Kind: inner constant of useNavigationPath
# useNavigationPath~setupNavigationPath(payload)
Setup the navigationPath
Kind: inner method of useNavigationPath
| Param | Type | Description |
|---|---|---|
| payload | Array | By default it generates a navigationPath based on the $route |