Skip to content
Fungi

components/dropdown-menu

@fungi.computer/caps

@fungi.computer/caps / components/dropdown-menu

components/dropdown-menu

Section titled “components/dropdown-menu”

Type Aliases

Section titled “Type Aliases”
Section titled “DropdownMenuChangeDetails”

DropdownMenuChangeDetails = BaseMenu.Root.ChangeEventDetails

Details supplied to a DropdownMenu open-change callback.

Section titled “DropdownMenuChangeReason”

DropdownMenuChangeReason = BaseMenu.Root.ChangeEventReason

Supported DropdownMenuChangeReason values.

Section titled “DropdownMenuInteractionOwner”

DropdownMenuInteractionOwner = "host" | "local"

Supported DropdownMenuInteractionOwner values.

Section titled “DropdownMenuProps”

DropdownMenuProps<Payload> > = BaseMenu.Root.Props<Payload> > & object

Props accepted by DropdownMenu.

Type Declaration

Section titled “Type Declaration”
interactionOwner?
Section titled “interactionOwner?”

optional interactionOwner?: DropdownMenuInteractionOwner

Type Parameters

Section titled “Type Parameters”
Payload
Section titled “Payload”

Payload = unknown

Section titled “DropdownMenuContentProps”

DropdownMenuContentProps = BaseMenu.Popup.Props & Pick<BaseMenu.Portal.Props, "container" | "keepMounted"> > & Pick<BaseMenu.Positioner.Props, "align" | "alignOffset" | "side" | "sideOffset">>

Props accepted by DropdownMenuContent.

Section titled “DropdownMenuItemProps”

DropdownMenuItemProps = Omit<BaseMenu.Item.Props, "onSelect"> > & object

Props accepted by DropdownMenuItem.

Type Declaration

Section titled “Type Declaration”
onSelect?
Section titled “onSelect?”

optional onSelect?: (event) => void

Called when this item is selected.

Parameters
Section titled “Parameters”
event
Section titled “event”

React.SyntheticEvent<HTMLDivElement>

Returns
Section titled “Returns”

void

variant?
Section titled “variant?”

optional variant?: "default" | "destructive"

Section titled “DropdownMenuCheckboxItemProps”

DropdownMenuCheckboxItemProps = Omit<BaseMenu.CheckboxItem.Props, "onSelect"> > & Pick<DropdownMenuItemProps, "onSelect">>

Props accepted by DropdownMenuCheckboxItem.

Variables

Section titled “Variables”
Section titled “DropdownMenuTrigger”

const DropdownMenuTrigger: ForwardRefExoticComponent<Omit<Props<unknown>>, "ref"> > & RefAttributes<HTMLButtonElement>>>>

The trigger control for a DropdownMenu.

Section titled “DropdownMenuPortal”

const DropdownMenuPortal: ForwardRefExoticComponent<Omit<MenuPortalProps, "ref"> > & RefAttributes<HTMLDivElement>> >> = BaseMenu.Portal

The native menu portal with caller-selected container and mount lifetime.

Section titled “DropdownMenuPositioner”

const DropdownMenuPositioner: ForwardRefExoticComponent<Omit<MenuPositionerProps, "ref"> > & RefAttributes<HTMLDivElement>> >> = BaseMenu.Positioner

The native positioning owner for anchors, collision boundaries and placement.

Section titled “DropdownMenuPopup”

const DropdownMenuPopup: ForwardRefExoticComponent<Omit<MenuPopupProps, "ref"> > & RefAttributes<HTMLDivElement>>>>

The styled popup for caller-composed menu placement and portal ownership.

Section titled “DropdownMenuContent”

const DropdownMenuContent: ForwardRefExoticComponent<Omit<DropdownMenuContentProps, "ref"> > & RefAttributes<HTMLDivElement>>>>

The positioned content region for a DropdownMenu.

Section titled “DropdownMenuItem”

const DropdownMenuItem: ForwardRefExoticComponent<Omit<DropdownMenuItemProps, "ref"> > & RefAttributes<HTMLElement>>>>

An actionable item in a DropdownMenu.

Section titled “DropdownMenuCheckboxItem”

const DropdownMenuCheckboxItem: ForwardRefExoticComponent<Omit<DropdownMenuCheckboxItemProps, "ref"> > & RefAttributes<HTMLElement>>>>

A checkable item in a DropdownMenu.

Section titled “DropdownMenuSeparator”

const DropdownMenuSeparator: ForwardRefExoticComponent<Omit<SeparatorProps, "ref"> > & RefAttributes<HTMLDivElement>>>>

A visual separator in a DropdownMenu.

Functions

Section titled “Functions”
Section titled “DropdownMenu()”

DropdownMenu<Payload>>(__namedParameters): Element

A menu controller with explicit controlled or uncontrolled open state.

Type Parameters

Section titled “Type Parameters”
Payload
Section titled “Payload”

Payload = unknown

Parameters

Section titled “Parameters”
__namedParameters
Section titled “__namedParameters”

DropdownMenuProps<Payload>

Returns

Section titled “Returns”

Element

useDropdownMenu()

Section titled “useDropdownMenu()”

useDropdownMenu(): object

Access the nearest DropdownMenu close operation.

Returns

Section titled “Returns”
close
Section titled “close”

close: () => void | undefined

Close the nearest menu, if it is mounted.

Returns
Section titled “Returns”

void | undefined