Wrapper

The Menu component wrapper.

This is a compound component.

API

This component extends the native <div> API. That's why the className prop is not included in the table.

Props
Type
Required

children

ReactNode

align

'start' | 'center' | 'end'

alignOffset

number

side

'top' | 'right' | 'bottom' | 'left'

sideOffset

number

defaultOpen

boolean

children

The children in this case, because it is a compound component, should be the ones provided by this design system.

align

This prop changes the position of the Menu based on the Trigger.

alignOffset

An offset in pixels from the "start" or "end" alignment options.

side

Controls the side the menu is rendered from, always based on the trigger. Will be reversed when collisions occur automatically.

sideOffset

The distance in pixels from the trigger.

defaultOpen

Controls a default open state for the menu.

Last updated