Interface NavigationBarProps

interface NavigationBarProps {
    backgroundColor?: "primary" | "secondary";
    centerElement?: {
        badges?: (null | BadgeProps)[];
        icons: IconProps[];
        links?: Omit<LinkProps, "children" | "onNavigate">[];
        type: "icons";
    } | {
        buttons: ButtonProps[];
        links?: Omit<LinkProps, "children" | "onNavigate">[];
        type: "buttons";
    } | {
        type: "text";
        value: string;
    };
    className?: string;
    hideBorder?: boolean;
    leftElement?: ReactNode;
    onNavigate?: ((href) => void);
    rightElement?: ReactNode;
    screenMode?: "desktop" | "mobile";
}

Properties

backgroundColor? centerElement? className? hideBorder? leftElement? onNavigate? rightElement? screenMode?

Properties

Optional backgroundColor

backgroundColor?: "primary" | "secondary"

Background color of sidebar

Optional centerElement

centerElement?: {
    badges?: (null | BadgeProps)[];
    icons: IconProps[];
    links?: Omit<LinkProps, "children" | "onNavigate">[];
    type: "icons";
} | {
    buttons: ButtonProps[];
    links?: Omit<LinkProps, "children" | "onNavigate">[];
    type: "buttons";
} | {
    type: "text";
    value: string;
}

Elements of navigation bar

Type declaration

Type declaration

Type declaration

  • type: "text"
  • value: string

Optional className

className?: string

Custom class to give the html component

Optional hideBorder

hideBorder?: boolean

Hide bottom border of the navigation bar (default false)

Optional leftElement

leftElement?: ReactNode

Navigation bar logo

Optional onNavigate

onNavigate?: ((href) => void)

Callback for navigation links

Type declaration

    • (href): void

    • Callback for navigation links

      Parameters

      • href: string

      Returns void

Optional rightElement

rightElement?: ReactNode

Right element

Optional screenMode

screenMode?: "desktop" | "mobile"

Type of nav bar to display (configures spacing and sizing)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc