Context Menu

Displays a menu triggered by right-click (contextmenu event) or a 700ms touch long-press.

Basic

Right-click the area to open a context menu with navigation items.

Right click here

With Checkboxes

Context menu with checkbox items and a radio group.

Right click here

Usage

julia
using Suite

ContextMenu(
    ContextMenuTrigger(
        Div(:class => "flex h-36 w-full items-center justify-center rounded-md border border-dashed",
            "Right click here"
        )
    ),
    ContextMenuContent(
        ContextMenuItem("Back"),
        ContextMenuItem("Forward"),
        ContextMenuItem("Reload"),
        ContextMenuSeparator(),
        ContextMenuItem("Bookmark"),
    )
)

Keyboard Interactions

KeyAction
Arrow DownMove focus to the next item
Arrow UpMove focus to the previous item
Enter / SpaceActivate the focused item
EscapeClose the context menu
Arrow RightOpen a submenu (when focused on a sub-trigger)
Arrow LeftClose a submenu (when inside a submenu)
Type-aheadFocus an item by typing its label text

API Reference

ContextMenu

PropTypeDefaultDescription
children...Any-Trigger and content elements
classString""Additional CSS classes

ContextMenuTrigger

PropTypeDefaultDescription
children...Any-The right-clickable area
classString""Additional CSS classes

ContextMenuContent

PropTypeDefaultDescription
children...Any-Menu items, separators, groups
align_offsetInt0Offset from the alignment edge in pixels
classString""Additional CSS classes

ContextMenuItem

PropTypeDefaultDescription
children...Any-Item content (text, shortcuts)
disabledBoolfalseDisable this item
classString""Additional CSS classes

ContextMenuCheckboxItem

PropTypeDefaultDescription
children...Any-Item content
checkedBoolfalseWhether the item is checked
disabledBoolfalseDisable this item
classString""Additional CSS classes

ContextMenuRadioGroup

PropTypeDefaultDescription
children...Any-Radio items
valueString""Currently selected value
classString""Additional CSS classes

ContextMenuRadioItem

PropTypeDefaultDescription
children...Any-Item content
valueString""Value for this radio option (required)
disabledBoolfalseDisable this item
classString""Additional CSS classes

ContextMenuSub

PropTypeDefaultDescription
children...Any-Sub-trigger and sub-content
classString""Additional CSS classes

ContextMenuSubTrigger

PropTypeDefaultDescription
children...Any-Trigger content
disabledBoolfalseDisable this trigger
classString""Additional CSS classes

ContextMenuSubContent

PropTypeDefaultDescription
children...Any-Submenu items
classString""Additional CSS classes

ContextMenuGroup

PropTypeDefaultDescription
children...Any-Grouped items
classString""Additional CSS classes

ContextMenuLabel

PropTypeDefaultDescription
children...Any-Label text
classString""Additional CSS classes

ContextMenuSeparator

PropTypeDefaultDescription
classString""Additional CSS classes

ContextMenuShortcut

PropTypeDefaultDescription
children...Any-Shortcut text (e.g. "Ctrl+R")
classString""Additional CSS classes

ContextMenuItemIndicator

PropTypeDefaultDescription
children...Any-Custom indicator content (optional)
classString""Additional CSS classes