Interface MenuProps

interface MenuProps {
    anchorToClassName: string;
    className?: string;
    isMenuOpen?: boolean;
    items?: Omit<MenuItemProps, "onNavigate">[] | ReactNode[];
    onMenuOpenUpdate: ((isMenuOpen) => void);
    onNavigate: ((to) => void);
    placement?: "left" | "right" | "top" | "bottom" | "left-end" | "left-start" | "right-end" | "right-start" | "top-end" | "top-start" | "bottom-end" | "bottom-start";
    size?: "compact" | "wide";
}

Properties

anchorToClassName className? isMenuOpen? items? onMenuOpenUpdate onNavigate placement? size?

Properties

anchorToClassName

anchorToClassName: string

Anchor to an element

Optional className

className?: string

Custom class to give the html component

Optional isMenuOpen

isMenuOpen?: boolean

Display Menu

Optional items

items?: Omit<MenuItemProps, "onNavigate">[] | ReactNode[]

Menu items

onMenuOpenUpdate

onMenuOpenUpdate: ((isMenuOpen) => void)

onMenuOpen callback

Type declaration

    • (isMenuOpen): void

    • onMenuOpen callback

      Parameters

      • isMenuOpen: boolean

      Returns void

onNavigate

onNavigate: ((to) => void)

onNavigate callback

Type declaration

    • (to): void

    • onNavigate callback

      Parameters

      • to: string

      Returns void

Optional placement

placement?: "left" | "right" | "top" | "bottom" | "left-end" | "left-start" | "right-end" | "right-start" | "top-end" | "top-start" | "bottom-end" | "bottom-start"

Menu popup location relative to anchor element

Optional size

size?: "compact" | "wide"

Controls padding and other menu size-related options

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc