useNavigationPathInfo

useNavigationPathInfo($route, level, previousRoute) ⇒ Object

Generates an object with information which has the format for the NavigationPath based on the current $route and given entity-level

Kind: global function

Param	Type	Description
$route	VueRoute	The $route, from the SetupContext
level	String	The level (entity) that you would like to generate the info for
previousRoute	Ref.<Object>	Previous route before the current, used to generate correct nested route data

• useNavigationPathInfo($route, level, previousRoute) ⇒ Object
  • ~levelSlugIndex : ComputedRef.<number>
  • ~hasLevelSlugIndex : ComputedRef.<boolean>
  • ~hasRouteData : ComputedRef.<boolean>
  • ~levelSlugKey : ComputedRef.<(string|undefined)>
  • ~levelIdIndex : ComputedRef.<number>
  • ~hasIdIndex : ComputedRef.<boolean>
  • ~levelIdKey : ComputedRef.<(string|undefined)>
  • ~levelId : ComputedRef.<(string|undefined)>
  • ~hasLevelId : ComputedRef.<boolean>
  • ~routeData : ComputedRef.<{i18nPrefix: *, route: {name: string, params: {}}, icon: (ComputedRef.<*>|WritableComputedRef.<object>), url: string}>

useNavigationPathInfo~levelSlugIndex : ComputedRef.<number>

Find the index based on the given level

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~hasLevelSlugIndex : ComputedRef.<boolean>

Check whether or not the given level was found in the slugs

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~hasRouteData : ComputedRef.<boolean>

Check if all data is found for the given level

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~levelSlugKey : ComputedRef.<(string|undefined)>

Returns the key based on the given level, when it was found

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~levelIdIndex : ComputedRef.<number>

Returns the index of the entityId

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~hasIdIndex : ComputedRef.<boolean>

Returns true when the id was found

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~levelIdKey : ComputedRef.<(string|undefined)>

Returns the key for the entityId

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~levelId : ComputedRef.<(string|undefined)>

Returns the entityId from $route.params

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~hasLevelId : ComputedRef.<boolean>

Returns if the levelId was found

Kind: inner constant of useNavigationPathInfo

useNavigationPathInfo~routeData : ComputedRef.<{i18nPrefix: *, route: {name: string, params: {}}, icon: (ComputedRef.<*>|WritableComputedRef.<object>), url: string}>

Composes all information for the level

Kind: inner constant of useNavigationPathInfo