@rws-aoa/react-library/dist/components/molecules/navigation-bar/NavigationBar.d.ts

RWS AOA Design System

import { AoaPage } from '../../atoms/_menu/menu-item/MenuItem';
import { AoaSetting } from '../../atoms/_menu/user-menu/UserMenu';
export interface AoaNavigationBarProps {
    /**
     * If your home page is not on the root url, use this prop to set the home path
     */
    readonly homePath?: string;
    /**
     * The name of the application that will be used for the Home tab
     */
    readonly name: string;
    /**
     * A list of all the pages and optional subpages to be shown in the menu
     */
    readonly pages: AoaPage[];
    /**
     * A list of all the settings to be shown in the menu
     */
    readonly settings: AoaSetting[];
    /**
     * Optional username to be displayed next to the settings menu
     */
    readonly username?: string;
}
/**
 * Constructs a navigation bar using pre-defined Rijks styling
 *
 * @param props - Props to pass to the navigation bar
 * @example
 * ```jsx
 * <AoaNavigationBar
 *  name="Demo App"
 *  pages={
 *    [
 *      {
 *        label: "Products",
 *        to: "/products",
 *        subItems: [
 *          {
 *            label: "Books",
 *            to: "/books",
 *            icon: <BookIcon />
 *          }
 *        ]
 *      }
 *    ]
 *  }
 * settings={[{ label: "Logout", onClick: () => console.log("Logout") }]}
 * />
 * ```
 */
export declare function AoaNavigationBar(props: AoaNavigationBarProps): import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=NavigationBar.d.ts.map