@k8ordo/ui

ContextMenu

A menu that opens where the user right-clicks. Use it for actions on one item, such as a file row.

Import

ts
import { ContextMenu } from '@k8ordo/ui';

Usage

The inside is DropdownMenu’s: Content, Item and SubMenu. Only how it opens and where it appears differ. From the keyboard, press Shift+F10 or the context-menu key on the focused area. When it closes from inside, with an item or Escape, focus returns to the element that had it before.

report.pdf
tsx
<ContextMenu.Root>
  <ContextMenu.Trigger
    renderItem={(props) => (
      <div {...props} tabIndex={0}>
        report.pdf
      </div>
    )}
  />
  <ContextMenu.Content>
    <ContextMenu.Item label="Rename" onAction={rename} />
    <ContextMenu.SubMenu label="Move to">
      <ContextMenu.Item label="Archive" onAction={archive} />
      <ContextMenu.Item label="Drafts" onAction={toDrafts} />
    </ContextMenu.SubMenu>
    <ContextMenu.Item label="Delete" onAction={remove} />
  </ContextMenu.Content>
</ContextMenu.Root>

Props

ContextMenu.Root

children?
Type: ReactNode
Default: -
defaultOpen?
Type: boolean
Default: -
isOpen?
Type: boolean
Default: -
onChange?
Type: (isOpen: boolean) => void
Default: -
PropTypeDefault
children?ReactNode-
defaultOpen?boolean-
isOpen?boolean-
onChange?(isOpen: boolean) => void-

ContextMenu.Trigger

renderItem
Type: (props: { onContextMenu: MouseEventHandler<HTMLElement>; }) => ReactElement
Default: -
PropTypeDefault
renderItem(props: { onContextMenu: MouseEventHandler<HTMLElement>; }) => ReactElement-

ContextMenu.Item

label
Type: string
Default: -
onAction
Type: () => void
Default: -
PropTypeDefault
labelstring-
onAction() => void-

ContextMenu.SubMenu

label
Type: string
Default: -
children?
Type: ReactNode
Default: -
PropTypeDefault
labelstring-
children?ReactNode-
k8ordo

React libraries that use Baseline features without holding back.