# Context Menu

Right-click menu with the shared menu look: foreground bar highlight, etched separators, left indicators.

Source: https://www.ui95.dev/ui/context-menu

## Examples

```tsx
import { useState } from "react"

import {
  ContextMenu,
  ContextMenuCheckboxItem,
  ContextMenuContent,
  ContextMenuGroup,
  ContextMenuItem,
  ContextMenuLabel,
  ContextMenuRadioGroup,
  ContextMenuRadioItem,
  ContextMenuSeparator,
  ContextMenuShortcut,
  ContextMenuSub,
  ContextMenuSubContent,
  ContextMenuSubTrigger,
  ContextMenuTrigger,
} from "@/components/ui/context-menu"

import type { ShowcaseDemo } from "../types"

function renderTrigger() {
  return (
    <ContextMenuTrigger className="flex h-16 w-full items-center justify-center pixel-border border-border bg-card font-pixel text-sm uppercase">
      Right click here
    </ContextMenuTrigger>
  )
}

function renderItemsMenu() {
  return (
    <ContextMenu>
      {renderTrigger()}
      <ContextMenuContent>
        <ContextMenuLabel>Document</ContextMenuLabel>
        <ContextMenuGroup>
          <ContextMenuItem>
            New
            <ContextMenuShortcut>Ctrl+N</ContextMenuShortcut>
          </ContextMenuItem>
          <ContextMenuItem>
            Open...
            <ContextMenuShortcut>Ctrl+O</ContextMenuShortcut>
          </ContextMenuItem>
          <ContextMenuItem disabled>
            Save
            <ContextMenuShortcut>Ctrl+S</ContextMenuShortcut>
          </ContextMenuItem>
        </ContextMenuGroup>
        <ContextMenuSeparator />
        <ContextMenuItem inset>Print preview</ContextMenuItem>
        <ContextMenuItem variant="destructive">Delete</ContextMenuItem>
      </ContextMenuContent>
    </ContextMenu>
  )
}

function SelectionMenu() {
  const [isStatusBarVisible, setIsStatusBarVisible] = useState(true)
  const [isGridVisible, setIsGridVisible] = useState(false)
  const [zoom, setZoom] = useState("100")

  return (
    <ContextMenu>
      {renderTrigger()}
      <ContextMenuContent>
        <ContextMenuCheckboxItem checked={isStatusBarVisible} onCheckedChange={setIsStatusBarVisible}>
          Status bar
        </ContextMenuCheckboxItem>
        <ContextMenuCheckboxItem checked={isGridVisible} onCheckedChange={setIsGridVisible}>
          Grid
        </ContextMenuCheckboxItem>
        <ContextMenuSeparator />
        <ContextMenuLabel inset>Zoom</ContextMenuLabel>
        <ContextMenuRadioGroup value={zoom} onValueChange={setZoom}>
          <ContextMenuRadioItem value="100">100%</ContextMenuRadioItem>
          <ContextMenuRadioItem value="200">200%</ContextMenuRadioItem>
          <ContextMenuRadioItem value="400">400%</ContextMenuRadioItem>
        </ContextMenuRadioGroup>
      </ContextMenuContent>
    </ContextMenu>
  )
}

function renderSubmenu() {
  return (
    <ContextMenu>
      {renderTrigger()}
      <ContextMenuContent>
        <ContextMenuItem>Defragment</ContextMenuItem>
        <ContextMenuSub>
          <ContextMenuSubTrigger>Accessories</ContextMenuSubTrigger>
          <ContextMenuSubContent>
            <ContextMenuItem>Calculator</ContextMenuItem>
            <ContextMenuItem>Notepad</ContextMenuItem>
            <ContextMenuItem>Paint</ContextMenuItem>
          </ContextMenuSubContent>
        </ContextMenuSub>
        <ContextMenuSeparator />
        <ContextMenuItem>Shut down...</ContextMenuItem>
      </ContextMenuContent>
    </ContextMenu>
  )
}

export const demo: ShowcaseDemo = {
  span: "single",
  variants: [
    { label: "items, shortcuts, disabled, inset, destructive", render: renderItemsMenu },
    { label: "checkbox and radio", render: () => <SelectionMenu /> },
    { label: "submenu", render: renderSubmenu },
  ],
}
```

## Installation

```bash
npx shadcn@latest add https://www.ui95.dev/r/context-menu.json
```

Run it in a Radix shadcn project that already has the UI95 theme.

Dependencies:

```bash
npm install cn radix-ui
```

Add these items first:

- [pixel-glyphs](https://www.ui95.dev/ui/pixel-glyphs)

`components/ui/context-menu.tsx`

```tsx
"use client"

import { cn } from "cn"
import { ContextMenu as ContextMenuPrimitive } from "radix-ui"
import * as React from "react"

import { ArrowGlyph, CheckGlyph, DotGlyph } from "@/components/ui/pixel-glyphs"

function ContextMenu({
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Root>) {
  return <ContextMenuPrimitive.Root data-slot="context-menu" {...props} />
}

function ContextMenuPortal({
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Portal>) {
  return (
    <ContextMenuPrimitive.Portal data-slot="context-menu-portal" {...props} />
  )
}

function ContextMenuTrigger({
  className,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Trigger>) {
  return (
    <ContextMenuPrimitive.Trigger
      data-slot="context-menu-trigger"
      className={cn("select-none", className)}
      {...props}
    />
  )
}

function ContextMenuContent({
  className,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Content> & {
  side?: "top" | "right" | "bottom" | "left"
}) {
  return (
    <ContextMenuPrimitive.Portal>
      <ContextMenuPrimitive.Content
        data-slot="context-menu-content"
        className={cn(
          "z-50 max-h-(--radix-context-menu-content-available-height) min-w-40 overflow-x-hidden overflow-y-auto pixel-border border-border bg-popover p-(--pixel) text-popover-foreground offset-shadow-2",
          className
        )}
        {...props}
      />
    </ContextMenuPrimitive.Portal>
  )
}

function ContextMenuGroup({
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Group>) {
  return (
    <ContextMenuPrimitive.Group data-slot="context-menu-group" {...props} />
  )
}

function ContextMenuItem({
  className,
  inset,
  variant = "default",
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Item> & {
  inset?: boolean
  variant?: "default" | "destructive"
}) {
  return (
    <ContextMenuPrimitive.Item
      data-slot="context-menu-item"
      data-inset={inset}
      data-variant={variant}
      className={cn(
        "group/context-menu-item relative flex h-8 items-center gap-2 px-2 text-xl leading-none outline-hidden select-none focus:bg-foreground focus:text-popover data-inset:pl-7 data-[variant=destructive]:text-destructive data-[variant=destructive]:focus:bg-destructive data-[variant=destructive]:focus:text-popover data-disabled:pointer-events-none data-disabled:text-muted-foreground [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-3.5",
        className
      )}
      {...props}
    />
  )
}

function ContextMenuCheckboxItem({
  className,
  children,
  checked,
  inset,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.CheckboxItem> & {
  inset?: boolean
}) {
  return (
    <ContextMenuPrimitive.CheckboxItem
      data-slot="context-menu-checkbox-item"
      data-inset={inset}
      className={cn(
        "relative flex h-8 items-center gap-2 pr-2 pl-7 text-xl leading-none outline-hidden select-none focus:bg-foreground focus:text-popover data-disabled:pointer-events-none data-disabled:text-muted-foreground [&_svg]:pointer-events-none [&_svg]:shrink-0",
        className
      )}
      checked={checked}
      {...props}
    >
      <span
        className="pointer-events-none absolute left-2 flex size-3.5 items-center justify-center"
        data-slot="context-menu-checkbox-item-indicator"
      >
        <ContextMenuPrimitive.ItemIndicator>
          <CheckGlyph />
        </ContextMenuPrimitive.ItemIndicator>
      </span>
      {children}
    </ContextMenuPrimitive.CheckboxItem>
  )
}

function ContextMenuRadioGroup({
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.RadioGroup>) {
  return (
    <ContextMenuPrimitive.RadioGroup
      data-slot="context-menu-radio-group"
      {...props}
    />
  )
}

function ContextMenuRadioItem({
  className,
  children,
  inset,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.RadioItem> & {
  inset?: boolean
}) {
  return (
    <ContextMenuPrimitive.RadioItem
      data-slot="context-menu-radio-item"
      data-inset={inset}
      className={cn(
        "relative flex h-8 items-center gap-2 pr-2 pl-7 text-xl leading-none outline-hidden select-none focus:bg-foreground focus:text-popover data-disabled:pointer-events-none data-disabled:text-muted-foreground [&_svg]:pointer-events-none [&_svg]:shrink-0",
        className
      )}
      {...props}
    >
      <span
        className="pointer-events-none absolute left-2 flex size-3.5 items-center justify-center"
        data-slot="context-menu-radio-item-indicator"
      >
        <ContextMenuPrimitive.ItemIndicator>
          <DotGlyph />
        </ContextMenuPrimitive.ItemIndicator>
      </span>
      {children}
    </ContextMenuPrimitive.RadioItem>
  )
}

function ContextMenuLabel({
  className,
  inset,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Label> & {
  inset?: boolean
}) {
  return (
    <ContextMenuPrimitive.Label
      data-slot="context-menu-label"
      data-inset={inset}
      className={cn(
        "px-2 pt-2 pb-1 font-pixel text-sm leading-none text-muted-foreground uppercase data-inset:pl-7",
        className
      )}
      {...props}
    />
  )
}

function ContextMenuSeparator({
  className,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Separator>) {
  return (
    <ContextMenuPrimitive.Separator
      data-slot="context-menu-separator"
      className={cn(
        "mx-1 my-1 border-t-(length:--pixel) border-b-(length:--pixel) border-t-bevel-lo border-b-bevel-hi",
        className
      )}
      {...props}
    />
  )
}

function ContextMenuShortcut({
  className,
  ...props
}: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="context-menu-shortcut"
      className={cn(
        "ml-auto pl-4 text-lg leading-none text-muted-foreground group-focus/context-menu-item:text-popover",
        className
      )}
      {...props}
    />
  )
}

function ContextMenuSub({
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.Sub>) {
  return <ContextMenuPrimitive.Sub data-slot="context-menu-sub" {...props} />
}

function ContextMenuSubTrigger({
  className,
  inset,
  children,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.SubTrigger> & {
  inset?: boolean
}) {
  return (
    <ContextMenuPrimitive.SubTrigger
      data-slot="context-menu-sub-trigger"
      data-inset={inset}
      className={cn(
        "flex h-8 items-center gap-2 px-2 text-xl leading-none outline-hidden select-none focus:bg-foreground focus:text-popover data-inset:pl-7 data-open:bg-foreground data-open:text-popover [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-3.5",
        className
      )}
      {...props}
    >
      {children}
      <ArrowGlyph direction="right" className="ml-auto" />
    </ContextMenuPrimitive.SubTrigger>
  )
}

function ContextMenuSubContent({
  className,
  ...props
}: React.ComponentProps<typeof ContextMenuPrimitive.SubContent>) {
  return (
    <ContextMenuPrimitive.SubContent
      data-slot="context-menu-sub-content"
      className={cn(
        "z-50 min-w-32 overflow-hidden pixel-border border-border bg-popover p-(--pixel) text-popover-foreground offset-shadow-2",
        className
      )}
      {...props}
    />
  )
}

export {
  ContextMenu,
  ContextMenuCheckboxItem,
  ContextMenuContent,
  ContextMenuGroup,
  ContextMenuItem,
  ContextMenuLabel,
  ContextMenuPortal,
  ContextMenuRadioGroup,
  ContextMenuRadioItem,
  ContextMenuSeparator,
  ContextMenuShortcut,
  ContextMenuSub,
  ContextMenuSubContent,
  ContextMenuSubTrigger,
  ContextMenuTrigger,
}
```

## API reference

### ContextMenu

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuCheckboxItem

| Prop | Type | Default |
| --- | --- | --- |
| `inset` | `boolean` | - |

### ContextMenuContent

| Prop | Type | Default |
| --- | --- | --- |
| `side` | `"left" \| "right" \| "top" \| "bottom"` | - |

### ContextMenuGroup

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuItem

| Prop | Type | Default |
| --- | --- | --- |
| `inset` | `boolean` | - |
| `variant` | `"default" \| "destructive"` | `"default"` |

### ContextMenuLabel

| Prop | Type | Default |
| --- | --- | --- |
| `inset` | `boolean` | - |

### ContextMenuPortal

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuRadioGroup

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuRadioItem

| Prop | Type | Default |
| --- | --- | --- |
| `inset` | `boolean` | - |

### ContextMenuSeparator

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuShortcut

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuSub

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuSubContent

No props of its own. It forwards the props of the element or primitive it wraps.

### ContextMenuSubTrigger

| Prop | Type | Default |
| --- | --- | --- |
| `inset` | `boolean` | - |

### ContextMenuTrigger

No props of its own. It forwards the props of the element or primitive it wraps.

## Sounds

- `menu.select`
