React Overlays

    DropdownMenu

    API

    import DropdownMenu from 'react-overlays/DropdownMenu'

    Also exported as <Dropdown.Menu> from Dropdown.

    alignEnd

    Aligns the dropdown menu to the 'end' of it's placement position. Generally this is provided by the parent Dropdown component, but may also be specified as a prop directly.

    type:boolean

    childrenrequired

    A render prop that returns a Menu element. The props argument should spread through to a component that can accept a ref.

    type:{Function ({ show: boolean, alignEnd: boolean, close: (?SyntheticEvent) => void, placement: Placement, update: () => void, forceUpdate: () => void, props: { ref: (?HTMLElement) => void, style: { [string]: string | number }, aria-labelledby: ?string }, arrowProps: { ref: (?HTMLElement) => void, style: { [string]: string | number }, }, }) => React.Element}

    flip

    Enables the Popper.js flip modifier, allowing the Dropdown to automatically adjust it's placement in case of overlap with the viewport or toggle. Refer to the flip docs for more info

    type:boolean

    offset

    type:Offset

    popperConfig

    A set of popper options and props passed directly to react-popper's Popper component.

    type:Omit<UsePopperOptions, 'enabled''placement'>

    rootCloseEvent

    Override the default event used by RootCloseWrapper.

    type:RootCloseOptions['clickTrigger']

    show

    Controls the visible state of the menu, generally this is provided by the parent Dropdown component, but may also be specified as a prop directly.

    type:boolean

    usePopper

    type:boolean
    default:true