@massds/mayflower-react/dist/HeaderHamburger/index.d.ts

React versions of Mayflower design system UI components

import React from 'react';
export interface HeaderHamburgerProps {
    /** An uninstantiated component which handles displaying the site logo. */
    Logo?: React.ElementType;
    /** An uninstantiated component which handles displaying the site logo on mobile. */
    MobileLogo?: React.ElementType;
    /** Override default siteName rendered as the hamburger menu toggle button text and aria-label on mobile */
    siteName?: string;
    /** An uninstantiated component which handles search functionality. */
    NavSearch?: React.ElementType;
    /** An uninstantiated component which handles search functionality on mobile. */
    MobileNavSearch?: React.ElementType;
    /** An uninstantiated component which handles the display of a skip navigation link. */
    SkipNav?: React.ElementType;
    /** An uninstantiated component which handles displaying the utility navigation at the top of the header. */
    UtilityNav?: React.ElementType;
    /** An uninstantiated component which handles the display of individual utility items. */
    UtilityItem?: React.ElementType;
    /** An uninstantiated component which handles the display of the main navigation and its links. */
    MainNav?: React.ElementType;
    /** An uninstantiated component which handles display of individual navigation items inside of the main navigation. */
    NavItem?: React.ElementType;
    /** An uninstantiated component that displays the site logo and search on desktop. */
    Container?: React.ElementType;
    /** An array of items used to create the menu. */
    mainItems?: {
        href?: string;
        text?: string;
        active?: boolean;
        subNav?: {
            href?: string;
            text?: string;
        }[];
    }[];
    /** Render a link to home site in place of the hamburger menu. */
    homeLink?: {
        text?: string;
        url?: string;
    };
    /** An array of uninstantiated components to render within the utility navigation.  */
    utilityItems?: React.ElementType[];
}
declare const HeaderHamburger: ({ Logo, MobileLogo, NavSearch, MobileNavSearch, SkipNav, UtilityNav, UtilityItem, MainNav, NavItem, Container, mainItems, utilityItems, siteName, homeLink }: HeaderHamburgerProps) => any;
export default HeaderHamburger;