Skip to main content

Context Menu

Context Menu is an overlay that shows actions for an item on right-click or long press, such as renaming or deleting a file.

Import

import { ContextMenu } from '@vortexlabs/vortex';
import type { ContextMenuProps } from '@vortexlabs/vortex';

Allied components

Other links

ContextMenu

ContextMenu props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value
`position`	`union`	`end-top`
`fallbackPositions`	`union`	No default value
`fallbackAdjustLayout`	`boolean`	No default value
`fallbackMinHeight`	`string`	No default value
`contentGap`	`number`	`0`
`contentShift`	`number`	No default value
`contentMaxHeight`	`union`	No default value
`width`	`string`	No default value
`onOpen`	`callback`	No default value
`onClose`	`callback`	No default value
`hideAnimationDisabled`	`boolean`	`true`
`closeOnOutsideClickDisabled`	`boolean`	No default value
`instanceRef`	`ref`	No default value
`initialFocusRef`	`ref`	No default value
`containerRef`	`ref`	`document.body`
`trapFocusMode`	`union`	`action-menu`

ContextMenu.Trigger

ContextMenu.Trigger props
Prop	Type	Default	Attributes
`children`	`callback`	No default value

ContextMenu.Content

ContextMenu.Content props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value

ContextMenu.Section

ContextMenu.Section props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value

ContextMenu.SectionLabel

ContextMenu.SectionLabel props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value

ContextMenu.Item

ContextMenu.Item props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value
`onClick`	`callback`	No default value
`shortcut`	`React.ReactNode`	No default value
`tone`	`"critical"`	No default value
`startIcon`	`component`	No default value
`disabled`	`boolean`	`false`
`href`	`string`	No default value
`openInNewTab`	`boolean`	No default value
`as`	`union`	No default value
`render`	`callback`	No default value
`stopPropagation`	`boolean`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value

ContextMenu.SubMenu

ContextMenu.SubMenu props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value
`position`	`union`	`end-top`
`fallbackPositions`	`union`	No default value
`fallbackAdjustLayout`	`boolean`	No default value
`fallbackMinHeight`	`string`	No default value
`contentGap`	`number`	`2.25`
`contentShift`	`number`	`-1.25`
`width`	`union`	No default value
`containerRef`	`ref`	`document.body`

ContextMenu.SubTrigger

ContextMenu.SubTrigger props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value
`startIcon`	`component`	No default value
`disabled`	`boolean`	`false`
`href`	`string`	No default value
`openInNewTab`	`boolean`	No default value
`as`	`union`	No default value
`render`	`callback`	No default value
`stopPropagation`	`boolean`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value