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

React versions of Mayflower design system UI components

import React from 'react';
export declare const HamburgerContext: any;
export interface HamburgerNavProps {
    /** An uninstantiated component which handles displaying the utility nav. */
    UtilityNav?: React.ElementType;
    /** An uninstantiated component which handles displaying individual items within the utility nav. */
    UtilityItem?: React.ElementType;
    /** An uninstantiated component which handles displaying menu portion of the header. */
    MainNav?: React.ElementType;
    /** An uninstantiated component which handles displaying individual menu items within the menu. */
    NavItem?: React.ElementType;
    /** An uninstantiated component which handles displaying the site logo. */
    Logo?: React.ElementType;
    /** An uninstantiated component which handles search functionality. */
    NavSearch?: React.ElementType;
    /** An array of items used to create the menu. */
    mainItems?: {
        href?: string;
        text?: string;
        active?: boolean;
        subNav?: {
            href?: string;
            text?: string;
        }[];
    }[];
    /** An array of uninstantiated components to render within the utility navigation.  */
    utilityItems?: React.ElementType[];
    /** A string that represents the type of header this component is displayed in. This is needed for figuring out when to display using slim or not. Currently only supports hamburger and mixed. */
    headerType?: string;
}
declare const HamburgerNav: ({ UtilityNav, UtilityItem, MainNav, NavItem, NavSearch, Logo, mainItems, utilityItems }: HamburgerNavProps) => any;
export interface HamburgerMainNavProps {
    /** An uninstantiated component which handles displaying individual menu items within the menu. */
    NavItem?: React.ElementType;
    /** An array of items used to create the menu. */
    items?: {
        href?: string;
        text?: string;
        active?: boolean;
        subNav?: {
            href?: string;
            text?: string;
        }[];
    }[];
}
export declare const HamburgerMainNav: ({ NavItem, items }: HamburgerMainNavProps) => any;
export interface HamburgerNavItemProps {
    href?: string;
    text?: string;
    active?: boolean;
    subNav?: {
        href?: string;
        text?: string;
    }[];
    index?: number | string;
}
export declare const HamburgerNavItem: ({ href, text, active, subNav, index }: HamburgerNavItemProps) => any;
export interface HamburgerUtilityItemProps {
    children?: React.ReactNode;
}
export declare const HamburgerUtilityItem: ({ children }: HamburgerUtilityItemProps) => any;
export interface HamburgerUtilityNavProps {
    /** An uninstantiated component which handles displaying individual items within the utility nav. */
    UtilityItem?: React.ElementType;
    /** An array of uninstantiated components to render within the utility navigation.  */
    items?: React.ElementType[];
    /** A boolean representing when the UtilityNav is being displayed within a narrow screen. */
    narrow?: boolean;
}
export declare const HamburgerUtilityNav: ({ UtilityItem, items, narrow }: HamburgerUtilityNavProps) => any;
export declare const HamburgerNavSearch: () => any;
export declare const HamburgerLogoWrapper: ({ children }: {
    children: any;
}) => any;
export interface HamburgerSiteLogoProps {
    /** An uninstantiated component which handles displaying the wrapper around the site logo, if any. */
    Wrapper?: React.ElementType;
}
export declare const HamburgerSiteLogo: ({ Wrapper }: HamburgerSiteLogoProps) => any;
export declare const HamburgerMobileLogoWrapper: ({ children }: {
    children: any;
}) => any;
export declare const HamburgerSkipNav: () => any;
export interface HamburgerContainerProps {
    /** An uninstantiated component which handles displaying the site logo. */
    Logo?: React.ElementType;
    /** An uninstantiated component which handles search functionality. */
    NavSearch?: React.ElementType;
}
export declare const HamburgerContainer: ({ Logo, NavSearch }: HamburgerContainerProps) => any;
export declare const HamburgerMobileNavSearch: () => any;
export default HamburgerNav;