Context Menu
A menu of actions for the thing under the pointer, opened by a right click or a long press.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuCheckboxItem,
ContextMenuContent,
ContextMenuGroup,
ContextMenuItem,
ContextMenuLabel,
ContextMenuRadioGroup,
ContextMenuRadioItem,
ContextMenuSeparator,
ContextMenuShortcut,
ContextMenuSub,
ContextMenuSubContent,
ContextMenuSubTrigger,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
menu: { minWidth: "12rem" },
})
export default function ContextMenuDemo() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent xstyle={styles.menu}>
<ContextMenuGroup>
<ContextMenuItem>
Duplicate
<ContextMenuShortcut>⌘D</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem>
Group
<ContextMenuShortcut>⌘G</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem disabled>
Ungroup
<ContextMenuShortcut>⇧⌘G</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuSub>
<ContextMenuSubTrigger>More Actions</ContextMenuSubTrigger>
<ContextMenuSubContent>
<ContextMenuItem>Rename Layer...</ContextMenuItem>
<ContextMenuItem>Export as PNG...</ContextMenuItem>
<ContextMenuItem>Copy as SVG</ContextMenuItem>
<ContextMenuSeparator />
<ContextMenuItem>Lock Layer</ContextMenuItem>
<ContextMenuSeparator />
<ContextMenuItem variant="destructive">Delete</ContextMenuItem>
</ContextMenuSubContent>
</ContextMenuSub>
</ContextMenuGroup>
<ContextMenuSeparator />
<ContextMenuGroup>
<ContextMenuCheckboxItem defaultChecked>Show Rulers</ContextMenuCheckboxItem>
<ContextMenuCheckboxItem>Snap to Grid</ContextMenuCheckboxItem>
</ContextMenuGroup>
<ContextMenuSeparator />
<ContextMenuGroup>
<ContextMenuLabel>People</ContextMenuLabel>
<ContextMenuRadioGroup defaultValue="ada">
<ContextMenuRadioItem value="ada">Ada Lovelace</ContextMenuRadioItem>
<ContextMenuRadioItem value="alan">Alan Turing</ContextMenuRadioItem>
</ContextMenuRadioGroup>
</ContextMenuGroup>
</ContextMenuContent>
</ContextMenu>
)
}Installation
pnpm dlx shadcn@latest add @arene/context-menunpx shadcn@latest add @arene/context-menuyarn dlx shadcn@latest add @arene/context-menubunx --bun shadcn@latest add @arene/context-menuNeeds the arene setup first.
Install the packages it imports:
pnpm add @base-ui/react @stylexjs/stylex clsx @phosphor-icons/reactnpm install @base-ui/react @stylexjs/stylex clsx @phosphor-icons/reactyarn add @base-ui/react @stylexjs/stylex clsx @phosphor-icons/reactbun add @base-ui/react @stylexjs/stylex clsx @phosphor-icons/reactSet up the token layer and the StyleX compiler, if you have not already. See
Installation, and paste states.ts and state-styles.ts
from the same page. The popup surface is shared, and the items read their
highlighted and disabled styles from Base UI's state. Include interop.css
for item icon sizing.
Paste this source into the file named in its title.
"use client"
import type { CSSProperties } from "react"
import { useRender } from "@base-ui/react/use-render"
import { ContextMenu as ContextMenuPrimitive } from "@base-ui/react/context-menu"
import * as stylex from "@stylexjs/stylex"
import type { StyleXStyles } from "@stylexjs/stylex"
import { clsx } from "clsx"
import { CheckIcon } from "@phosphor-icons/react/dist/csr/Check"
import { CaretRightIcon } from "@phosphor-icons/react/dist/csr/CaretRight"
import { stateStyles } from "@/lib/state-styles"
import { popupSlide, states } from "@/theme/states"
import {
color,
duration,
ease,
layer,
leading,
radius,
shadow,
space,
text,
tracking,
} from "@/theme/tokens.stylex"
const styles = stylex.create({
trigger: { userSelect: "none" },
content: {
zIndex: layer.popup,
maxHeight: "var(--available-height)",
minWidth: "9rem",
overflowX: "hidden",
overflowY: "auto",
"--arene-popup-radius": radius.lg,
borderRadius: "var(--arene-popup-radius)",
padding: space.s1,
transformOrigin: "var(--transform-origin)",
transitionProperty: "opacity, transform",
transitionDuration: {
default: duration.fade,
"@media (prefers-reduced-motion: reduce)": "0s",
},
transitionTimingFunction: ease.standard,
},
subContent: {
width: "auto",
minWidth: "8rem",
boxShadow: shadow.popupLifted,
},
label: {
paddingInline: space.s1_5,
paddingBlock: space.s1,
fontSize: text.xs,
lineHeight: leading.xs,
fontWeight: 500,
color: color.mutedForeground,
},
item: {
position: "relative",
display: "flex",
alignItems: "center",
gap: space.s1_5,
cursor: "default",
userSelect: "none",
paddingInline: space.s1_5,
paddingBlock: space.s1,
fontSize: text.sm,
lineHeight: leading.sm,
outlineStyle: "none",
"--arene-icon-size": space.s4,
},
inset: { paddingInlineStart: space.s7 },
destructive: { color: color.destructive },
indicatorItem: { paddingInlineEnd: space.s8 },
indicator: {
pointerEvents: "none",
position: "absolute",
insetInlineEnd: space.s2,
display: "flex",
alignItems: "center",
justifyContent: "center",
},
chevron: { marginInlineStart: "auto" },
separator: {
marginInline: `calc(-1 * ${space.s1})`,
marginBlock: space.s1,
height: 1,
backgroundColor: color.border,
},
shortcut: {
marginInlineStart: "auto",
fontSize: text.xs,
lineHeight: leading.xs,
letterSpacing: tracking.widest,
color: color.mutedForeground,
},
})
type ItemVariant = "default" | "destructive"
type Overrides = { xstyle?: StyleXStyles; className?: string }
type StateOverrides = Overrides & { style?: CSSProperties }
function ContextMenu(props: ContextMenuPrimitive.Root.Props) {
return <ContextMenuPrimitive.Root {...props} />
}
function ContextMenuPortal(props: ContextMenuPrimitive.Portal.Props) {
return <ContextMenuPrimitive.Portal {...props} />
}
type ContextMenuTriggerProps = Omit<ContextMenuPrimitive.Trigger.Props, "className"> & Overrides
function ContextMenuTrigger({ xstyle, className, ...props }: ContextMenuTriggerProps) {
const sx = stylex.props(styles.trigger, xstyle)
return (
<ContextMenuPrimitive.Trigger
data-slot="context-menu-trigger"
{...sx}
{...props}
className={clsx(sx.className, className)}
/>
)
}
type ContextMenuContentProps = Omit<ContextMenuPrimitive.Popup.Props, "className" | "style"> &
Pick<ContextMenuPrimitive.Positioner.Props, "align" | "alignOffset" | "side" | "sideOffset"> &
StateOverrides
function ContextMenuContent({
xstyle,
style,
className,
side = "right",
sideOffset = 0,
align = "start",
alignOffset = 4,
...props
}: ContextMenuContentProps) {
return (
<ContextMenuPrimitive.Portal>
<ContextMenuPrimitive.Positioner
align={align}
alignOffset={alignOffset}
side={side}
sideOffset={sideOffset}
{...stylex.props(states.positioner)}
>
<ContextMenuPrimitive.Popup
data-slot="context-menu-content"
{...props}
{...stateStyles(
(state) => [
states.popupSurface,
styles.content,
(state.transitionStatus === "starting" || state.transitionStatus === "ending") &&
states.transparent,
(state.transitionStatus === "starting" || state.transitionStatus === "ending") &&
popupSlide[state.side],
xstyle,
],
{ className, style },
)}
/>
</ContextMenuPrimitive.Positioner>
</ContextMenuPrimitive.Portal>
)
}
function ContextMenuGroup(props: ContextMenuPrimitive.Group.Props) {
return <ContextMenuPrimitive.Group data-slot="context-menu-group" {...props} />
}
type ContextMenuLabelProps = Omit<ContextMenuPrimitive.GroupLabel.Props, "className"> &
Overrides & { inset?: boolean }
function ContextMenuLabel({ xstyle, className, inset, ...props }: ContextMenuLabelProps) {
const sx = stylex.props(styles.label, inset && styles.inset, xstyle)
return (
<ContextMenuPrimitive.GroupLabel
data-slot="context-menu-label"
data-inset={inset || undefined}
{...sx}
{...props}
className={clsx(sx.className, className)}
/>
)
}
type ContextMenuItemProps = Omit<ContextMenuPrimitive.Item.Props, "className" | "style"> &
StateOverrides & { inset?: boolean; variant?: ItemVariant }
function ContextMenuItem({
xstyle,
style,
className,
inset,
variant = "default",
...props
}: ContextMenuItemProps) {
const destructive = variant === "destructive"
return (
<ContextMenuPrimitive.Item
data-slot="context-menu-item"
data-inset={inset || undefined}
data-variant={variant}
{...props}
{...stateStyles(
(state) => [
styles.item,
states.popupItem,
inset && styles.inset,
destructive && styles.destructive,
state.highlighted &&
(destructive ? states.itemHighlightDestructive : states.itemHighlight),
state.disabled && states.disabled,
xstyle,
],
{ className, style, hook: "arene-icons" },
)}
/>
)
}
type ContextMenuCheckboxItemProps = Omit<
ContextMenuPrimitive.CheckboxItem.Props,
"className" | "style"
> &
StateOverrides & { inset?: boolean }
function ContextMenuCheckboxItem({
xstyle,
style,
className,
inset,
children,
...props
}: ContextMenuCheckboxItemProps) {
return (
<ContextMenuPrimitive.CheckboxItem
data-slot="context-menu-checkbox-item"
data-inset={inset || undefined}
{...props}
{...stateStyles(
(state) => [
styles.item,
states.popupItem,
styles.indicatorItem,
inset && styles.inset,
state.highlighted && states.itemHighlight,
state.disabled && states.disabled,
xstyle,
],
{ className, style, hook: "arene-icons" },
)}
>
<span data-slot="context-menu-checkbox-item-indicator" {...stylex.props(styles.indicator)}>
<ContextMenuPrimitive.CheckboxItemIndicator>
<CheckIcon aria-hidden="true" />
</ContextMenuPrimitive.CheckboxItemIndicator>
</span>
{children}
</ContextMenuPrimitive.CheckboxItem>
)
}
function ContextMenuRadioGroup(props: ContextMenuPrimitive.RadioGroup.Props) {
return <ContextMenuPrimitive.RadioGroup data-slot="context-menu-radio-group" {...props} />
}
type ContextMenuRadioItemProps = Omit<ContextMenuPrimitive.RadioItem.Props, "className" | "style"> &
StateOverrides & { inset?: boolean }
function ContextMenuRadioItem({
xstyle,
style,
className,
inset,
children,
...props
}: ContextMenuRadioItemProps) {
return (
<ContextMenuPrimitive.RadioItem
data-slot="context-menu-radio-item"
data-inset={inset || undefined}
{...props}
{...stateStyles(
(state) => [
styles.item,
states.popupItem,
styles.indicatorItem,
inset && styles.inset,
state.highlighted && states.itemHighlight,
state.disabled && states.disabled,
xstyle,
],
{ className, style, hook: "arene-icons" },
)}
>
<span data-slot="context-menu-radio-item-indicator" {...stylex.props(styles.indicator)}>
<ContextMenuPrimitive.RadioItemIndicator>
<CheckIcon aria-hidden="true" />
</ContextMenuPrimitive.RadioItemIndicator>
</span>
{children}
</ContextMenuPrimitive.RadioItem>
)
}
type ContextMenuSeparatorProps = Omit<ContextMenuPrimitive.Separator.Props, "className"> & Overrides
function ContextMenuSeparator({ xstyle, className, ...props }: ContextMenuSeparatorProps) {
const sx = stylex.props(styles.separator, xstyle)
return (
<ContextMenuPrimitive.Separator
data-slot="context-menu-separator"
{...sx}
{...props}
className={clsx(sx.className, className)}
/>
)
}
type ContextMenuShortcutProps = useRender.ComponentProps<"span"> & Overrides
function ContextMenuShortcut({
render,
ref,
style,
xstyle,
className,
...props
}: ContextMenuShortcutProps) {
const sx = stylex.props(styles.shortcut, xstyle)
return useRender({
defaultTagName: "span",
render,
ref,
props: {
"data-slot": "context-menu-shortcut",
...sx,
...props,
className: clsx(sx.className, className),
style: { ...sx.style, ...style },
},
})
}
function ContextMenuSub(props: ContextMenuPrimitive.SubmenuRoot.Props) {
return <ContextMenuPrimitive.SubmenuRoot {...props} />
}
type ContextMenuSubTriggerProps = Omit<
ContextMenuPrimitive.SubmenuTrigger.Props,
"className" | "style"
> &
StateOverrides & { inset?: boolean }
function ContextMenuSubTrigger({
xstyle,
style,
className,
inset,
children,
...props
}: ContextMenuSubTriggerProps) {
return (
<ContextMenuPrimitive.SubmenuTrigger
data-slot="context-menu-sub-trigger"
data-inset={inset || undefined}
{...props}
{...stateStyles(
(state) => [
styles.item,
states.popupItem,
inset && styles.inset,
(state.highlighted || state.open) && states.itemHighlight,
state.disabled && states.disabled,
xstyle,
],
{ className, style, hook: "arene-icons" },
)}
>
{children}
<CaretRightIcon aria-hidden="true" {...stylex.props(styles.chevron)} />
</ContextMenuPrimitive.SubmenuTrigger>
)
}
function ContextMenuSubContent({
xstyle,
side = "right",
sideOffset = 0,
align = "start",
alignOffset = -3,
...props
}: ContextMenuContentProps) {
return (
<ContextMenuContent
data-slot="context-menu-sub-content"
side={side}
sideOffset={sideOffset}
align={align}
alignOffset={alignOffset}
xstyle={[styles.subContent, xstyle]}
{...props}
/>
)
}
export {
ContextMenu,
ContextMenuCheckboxItem,
ContextMenuContent,
ContextMenuGroup,
ContextMenuItem,
ContextMenuLabel,
ContextMenuPortal,
ContextMenuRadioGroup,
ContextMenuRadioItem,
ContextMenuSeparator,
ContextMenuShortcut,
ContextMenuSub,
ContextMenuSubContent,
ContextMenuSubTrigger,
ContextMenuTrigger,
}Change the @/ imports if your project uses different aliases.
Usage
import {
ContextMenu,
ContextMenuContent,
ContextMenuItem,
ContextMenuSeparator,
ContextMenuTrigger,
} from "@/components/ui/context-menu"<ContextMenu>
<ContextMenuTrigger>Right click here</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuItem>Rename</ContextMenuItem>
<ContextMenuItem>Duplicate</ContextMenuItem>
<ContextMenuSeparator />
<ContextMenuItem variant="destructive">Delete</ContextMenuItem>
</ContextMenuContent>
</ContextMenu>ContextMenuTrigger renders a bare <div> with no size and no appearance. Give
it both, or pass the element you already have through render. A right click or
a half-second long press opens the menu.
The menu anchors to the point that opened it, not to the trigger box. side and
align are measured from the cursor, so a trigger that fills the viewport still
gets a menu beside the pointer.
Basic
The content holds items directly. Nothing has to be grouped.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuItem,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
})
export default function ContextMenuBasic() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuItem>Duplicate</ContextMenuItem>
<ContextMenuItem disabled>Ungroup</ContextMenuItem>
<ContextMenuItem>Bring to Front</ContextMenuItem>
</ContextMenuContent>
</ContextMenu>
)
}Submenu
Nest secondary actions in a ContextMenuSub. A submenu anchors to its trigger
row rather than to the cursor.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuItem,
ContextMenuSeparator,
ContextMenuShortcut,
ContextMenuSub,
ContextMenuSubContent,
ContextMenuSubTrigger,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
})
export default function ContextMenuSubmenu() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuItem>
Copy
<ContextMenuShortcut>⌘C</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem>
Cut
<ContextMenuShortcut>⌘X</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuSub>
<ContextMenuSubTrigger>Export</ContextMenuSubTrigger>
<ContextMenuSubContent>
<ContextMenuItem>Export as PNG...</ContextMenuItem>
<ContextMenuItem>Export as SVG...</ContextMenuItem>
<ContextMenuSub>
<ContextMenuSubTrigger>Share</ContextMenuSubTrigger>
<ContextMenuSubContent>
<ContextMenuItem>Copy Embed Code</ContextMenuItem>
<ContextMenuItem>Copy Link</ContextMenuItem>
</ContextMenuSubContent>
</ContextMenuSub>
<ContextMenuSeparator />
<ContextMenuItem>Copy as CSS</ContextMenuItem>
</ContextMenuSubContent>
</ContextMenuSub>
</ContextMenuContent>
</ContextMenu>
)
}Shortcuts
Use ContextMenuShortcut to show a key combination at the trailing edge of an
item. It displays the key only. Wire the binding yourself.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuGroup,
ContextMenuItem,
ContextMenuSeparator,
ContextMenuShortcut,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
})
export default function ContextMenuShortcuts() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuGroup>
<ContextMenuItem>
Duplicate
<ContextMenuShortcut>⌘D</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem>
Group
<ContextMenuShortcut>⌘G</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem disabled>
Ungroup
<ContextMenuShortcut>⇧⌘G</ContextMenuShortcut>
</ContextMenuItem>
</ContextMenuGroup>
<ContextMenuSeparator />
<ContextMenuGroup>
<ContextMenuItem>
Bring Forward
<ContextMenuShortcut>⌘]</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem>
Send Backward
<ContextMenuShortcut>⌘[</ContextMenuShortcut>
</ContextMenuItem>
</ContextMenuGroup>
</ContextMenuContent>
</ContextMenu>
)
}Groups
Wrap related items in a ContextMenuGroup, name it with ContextMenuLabel and
divide groups with ContextMenuSeparator. A screen reader announces the label
as the name of its group.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuGroup,
ContextMenuItem,
ContextMenuLabel,
ContextMenuSeparator,
ContextMenuShortcut,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
})
export default function ContextMenuGroups() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuGroup>
<ContextMenuLabel>File</ContextMenuLabel>
<ContextMenuItem>
New File
<ContextMenuShortcut>⌘N</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem>
Open File
<ContextMenuShortcut>⌘O</ContextMenuShortcut>
</ContextMenuItem>
</ContextMenuGroup>
<ContextMenuSeparator />
<ContextMenuGroup>
<ContextMenuLabel>Edit</ContextMenuLabel>
<ContextMenuItem>
Undo
<ContextMenuShortcut>⌘Z</ContextMenuShortcut>
</ContextMenuItem>
<ContextMenuItem>
Redo
<ContextMenuShortcut>⇧⌘Z</ContextMenuShortcut>
</ContextMenuItem>
</ContextMenuGroup>
<ContextMenuSeparator />
<ContextMenuGroup>
<ContextMenuItem variant="destructive">
Delete
<ContextMenuShortcut>⌫</ContextMenuShortcut>
</ContextMenuItem>
</ContextMenuGroup>
</ContextMenuContent>
</ContextMenu>
)
}Icons
Place an icon before the label. The item sizes it.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuItem,
ContextMenuSeparator,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
import { ClipboardTextIcon } from "@phosphor-icons/react/dist/csr/ClipboardText"
import { CopyIcon } from "@phosphor-icons/react/dist/csr/Copy"
import { ScissorsIcon } from "@phosphor-icons/react/dist/csr/Scissors"
import { TrashIcon } from "@phosphor-icons/react/dist/csr/Trash"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
})
export default function ContextMenuIcons() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuItem>
<CopyIcon aria-hidden="true" />
Copy
</ContextMenuItem>
<ContextMenuItem>
<ScissorsIcon aria-hidden="true" />
Cut
</ContextMenuItem>
<ContextMenuItem>
<ClipboardTextIcon aria-hidden="true" />
Paste
</ContextMenuItem>
<ContextMenuSeparator />
<ContextMenuItem variant="destructive">
<TrashIcon aria-hidden="true" />
Delete
</ContextMenuItem>
</ContextMenuContent>
</ContextMenu>
)
}Checkboxes
Use ContextMenuCheckboxItem for items that toggle. Pass checked and
onCheckedChange to control it, or defaultChecked to leave it uncontrolled.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuCheckboxItem,
ContextMenuContent,
ContextMenuGroup,
ContextMenuLabel,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
menu: { minWidth: "12rem" },
})
export default function ContextMenuCheckboxes() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent xstyle={styles.menu}>
<ContextMenuGroup>
<ContextMenuLabel>View</ContextMenuLabel>
<ContextMenuCheckboxItem defaultChecked>Show Rulers</ContextMenuCheckboxItem>
<ContextMenuCheckboxItem>Snap to Grid</ContextMenuCheckboxItem>
<ContextMenuCheckboxItem disabled>Show Pixel Grid</ContextMenuCheckboxItem>
</ContextMenuGroup>
</ContextMenuContent>
</ContextMenu>
)
}Radio group
Use ContextMenuRadioGroup to hold one value across its ContextMenuRadioItems.
Pass value and onValueChange, or defaultValue.
"use client"
import { useState } from "react"
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuGroup,
ContextMenuLabel,
ContextMenuRadioGroup,
ContextMenuRadioItem,
ContextMenuSeparator,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
})
export default function ContextMenuRadio() {
const [person, setPerson] = useState("ada")
const [theme, setTheme] = useState("light")
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuGroup>
<ContextMenuLabel>People</ContextMenuLabel>
<ContextMenuRadioGroup value={person} onValueChange={setPerson}>
<ContextMenuRadioItem value="ada">Ada Lovelace</ContextMenuRadioItem>
<ContextMenuRadioItem value="alan">Alan Turing</ContextMenuRadioItem>
</ContextMenuRadioGroup>
</ContextMenuGroup>
<ContextMenuSeparator />
<ContextMenuGroup>
<ContextMenuLabel>Theme</ContextMenuLabel>
<ContextMenuRadioGroup value={theme} onValueChange={setTheme}>
<ContextMenuRadioItem value="light">Light</ContextMenuRadioItem>
<ContextMenuRadioItem value="dark">Dark</ContextMenuRadioItem>
<ContextMenuRadioItem value="system">System</ContextMenuRadioItem>
</ContextMenuRadioGroup>
</ContextMenuGroup>
</ContextMenuContent>
</ContextMenu>
)
}Destructive
Set variant="destructive" on an item to colour it and its icon.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuItem,
ContextMenuSeparator,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, text, width } from "@/theme/tokens.stylex"
import { ArchiveIcon } from "@phosphor-icons/react/dist/csr/Archive"
import { PencilSimpleIcon } from "@phosphor-icons/react/dist/csr/PencilSimple"
import { ShareNetworkIcon } from "@phosphor-icons/react/dist/csr/ShareNetwork"
import { TrashIcon } from "@phosphor-icons/react/dist/csr/Trash"
const styles = stylex.create({
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
width: "100%",
maxWidth: width.xs,
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
fine: { display: { default: "none", "@media (pointer: fine)": "inline" } },
coarse: { display: { default: "none", "@media (pointer: coarse)": "inline" } },
})
export default function ContextMenuDestructive() {
return (
<ContextMenu>
<ContextMenuTrigger xstyle={styles.dropzone}>
<span {...stylex.props(styles.fine)}>Right click here</span>
<span {...stylex.props(styles.coarse)}>Long press here</span>
</ContextMenuTrigger>
<ContextMenuContent>
<ContextMenuItem>
<PencilSimpleIcon aria-hidden="true" />
Edit
</ContextMenuItem>
<ContextMenuItem>
<ShareNetworkIcon aria-hidden="true" />
Share
</ContextMenuItem>
<ContextMenuItem>
<ArchiveIcon aria-hidden="true" />
Archive
</ContextMenuItem>
<ContextMenuSeparator />
<ContextMenuItem variant="destructive">
<TrashIcon aria-hidden="true" />
Delete
</ContextMenuItem>
</ContextMenuContent>
</ContextMenu>
)
}Sides
Set side to move the menu around the cursor. Use "inline-start" or
"inline-end" instead of "left" or "right" to have the side follow the
writing direction.
import * as stylex from "@stylexjs/stylex"
import {
ContextMenu,
ContextMenuContent,
ContextMenuItem,
ContextMenuTrigger,
} from "@/components/ui/context-menu"
import { leading, radius, space, text, width } from "@/theme/tokens.stylex"
const styles = stylex.create({
grid: {
display: "grid",
width: "100%",
maxWidth: width.sm,
gridTemplateColumns: "repeat(2, minmax(0, 1fr))",
gap: space.s4,
},
dropzone: {
display: "flex",
aspectRatio: "16 / 9",
alignItems: "center",
justifyContent: "center",
borderRadius: radius.xl,
borderWidth: 1,
borderStyle: "dashed",
fontSize: text.sm,
lineHeight: leading.sm,
},
})
const sides = ["top", "right", "bottom", "left"] as const
export default function ContextMenuSides() {
return (
<div {...stylex.props(styles.grid)}>
{sides.map((side) => (
<ContextMenu key={side}>
<ContextMenuTrigger xstyle={styles.dropzone}>{side}</ContextMenuTrigger>
<ContextMenuContent side={side}>
<ContextMenuItem>Duplicate</ContextMenuItem>
<ContextMenuItem>Rename</ContextMenuItem>
<ContextMenuItem>Lock</ContextMenuItem>
</ContextMenuContent>
</ContextMenu>
))}
</div>
)
}API reference
Pass render to replace a part's element or compose it with another component.
Every part wraps the Base UI ContextMenu part of the same name and accepts its
props. See the
Base UI reference for the
full list. Each styled part also takes xstyle and className. The items and
ContextMenuSubTrigger take style as well, which is real inline CSS applied
over the compiled styles rather than a StyleX override.
ContextMenu takes the Menu root's props apart from modal, openOnHover,
delay and closeDelay, which a context menu has no use for.
ContextMenuContent
| Prop | Type | Default |
|---|---|---|
side | "top" | "bottom" | "left" | "right" | "inline-start" | "inline-end" | "right" |
sideOffset | number | 0 |
align | "start" | "center" | "end" | "start" |
alignOffset | number | 4 |
The defaults place the menu below and to the right of the pointer, the way a
native menu does. The popup is never narrower than 9rem. Set a wider floor
through xstyle.
ContextMenuSubContent
The same props, with alignOffset={-3} as its default, which pulls the submenu
back by the popup padding so its first item lines up with the row that opened
it.
ContextMenuItem
| Prop | Type | Default |
|---|---|---|
variant | "default" | "destructive" | "default" |
inset | boolean | — |
disabled | boolean | — |
inset pads the leading edge by the width of an indicator column, so a plain
item lines up with checkbox and radio items beside it. ContextMenuLabel,
ContextMenuSubTrigger, ContextMenuCheckboxItem and ContextMenuRadioItem
take inset too.
ContextMenuCheckboxItem
| Prop | Type | Default |
|---|---|---|
checked | boolean | — |
defaultChecked | boolean | — |
onCheckedChange | (checked: boolean) => void | — |
ContextMenuRadioGroup
| Prop | Type | Default |
|---|---|---|
value | string | — |
defaultValue | string | — |
onValueChange | (value: string) => void | — |
Data attributes
| Attribute | On | Effect |
|---|---|---|
data-slot="context-menu-trigger" | the trigger | Targets the area from a parent |
data-slot="context-menu-content" | the popup | Popup surface |
data-side, data-align | the popup | Base UI writes them. data-side picks the slide direction |
data-starting-style, data-ending-style | the popup | Base UI writes them while the popup animates in or out |
data-slot="context-menu-item" | an item | Targets items from a parent |
data-variant | an item | Reflects the variant prop |
data-inset | an item | Present when inset is set |
data-highlighted, data-disabled | an item | Base UI writes them |