@toolpad/core/esm/shared/navigation.d.ts

Dashboard framework powered by Material UI.

import type { Navigation, NavigationItem, NavigationPageItem, NavigationSubheaderItem } from '../AppProvider';
export declare const getItemKind: (item: NavigationItem) => "header" | "page" | "divider";
export declare const isPageItem: (item: NavigationItem) => item is NavigationPageItem;
export declare const getItemTitle: (item: NavigationPageItem | NavigationSubheaderItem) => string;
/**
 * Matches a path against the navigation to find the active page. i.e. the page that should be
 * marked as selected in the navigation.
 */
export declare function matchPath(navigation: Navigation, path: string): NavigationPageItem | null;
/**
 * Gets the path for a specific navigation page item.
 */
export declare function getItemPath(navigation: Navigation, item: NavigationPageItem): string;
/**
 * Checks if a specific navigation page item has the active page as a child item.
 */
export declare function hasSelectedNavigationChildren(navigation: Navigation, item: NavigationPageItem, activePagePath: string): boolean;