useNavigation

Category:

Navigation & Routing

Composable for navigation. Provides state for navigation trees depending on navigation type.

Types

export function useNavigation(params?: {
  type?: Schemas["NavigationType"] | string;
}): UseNavigationReturn

source code

export type UseNavigationReturn = {
  /**
   * List of navigation elements
   */
  navigationElements: ComputedRef<Schemas["NavigationRouteResponse"] | null>;
  /**
   * Load navigation elements
   */
  loadNavigationElements(params: {
    depth: number;
  }): Promise<Schemas["NavigationRouteResponse"]>;
};

source code