Right click here

Installation

pnpm dlx kliping@latest add context-menu

Usage

<script setup lang="ts">
import {
  ContextMenu,
  ContextMenuContent,
  ContextMenuItem,
  ContextMenuSeparator,
  ContextMenuTrigger,
} from '@/components/ui/context-menu'
</script>

<template>
  <ContextMenu>
    <ContextMenuTrigger>Right click</ContextMenuTrigger>
    <ContextMenuContent>
      <ContextMenuItem>Profile</ContextMenuItem>
      <ContextMenuItem>Billing</ContextMenuItem>
      <ContextMenuItem>Team</ContextMenuItem>
      <ContextMenuSeparator />
      <ContextMenuItem>Subscription</ContextMenuItem>
    </ContextMenuContent>
  </ContextMenu>
</template>

Requirements

Semua dipasang otomatis oleh kliping add; tabel ini untuk Anda yang memasang manual atau memeriksa project.

Requirement	Value
Project	Vue 3.5+, Tailwind CSS v4, alias @ — disiapkan kliping init
npm packages	@lucide/vue@^1.31.0, @vueuse/core@^14.4.0, reka-ui@^2.10.3
Files	components/ui/context-menu/context-menu.vue components/ui/context-menu/context-menu-checkbox-item.vue components/ui/context-menu/context-menu-content.vue components/ui/context-menu/context-menu-group.vue components/ui/context-menu/context-menu-item.vue components/ui/context-menu/context-menu-label.vue components/ui/context-menu/context-menu-portal.vue components/ui/context-menu/context-menu-radio-group.vue components/ui/context-menu/context-menu-radio-item.vue components/ui/context-menu/context-menu-separator.vue components/ui/context-menu/context-menu-shortcut.vue components/ui/context-menu/context-menu-sub.vue components/ui/context-menu/context-menu-sub-content.vue components/ui/context-menu/context-menu-sub-trigger.vue components/ui/context-menu/context-menu-trigger.vue components/ui/context-menu/index.ts

Anatomy

Susunan bagiannya seperti dipakai di contoh-contoh di atas. Impor semua bagian dari satu tempat, lalu susun begini:

<ContextMenu>
  <ContextMenuTrigger />
  <ContextMenuContent>
    <ContextMenuItem>
      <ContextMenuShortcut />
    </ContextMenuItem>
    <ContextMenuSub>
      <ContextMenuSubTrigger />
      <ContextMenuSubContent>
        <ContextMenuItem>
          <ContextMenuShortcut />
        </ContextMenuItem>
        <ContextMenuSeparator />
      </ContextMenuSubContent>
    </ContextMenuSub>
    <ContextMenuSeparator />
    <ContextMenuCheckboxItem>
      <ContextMenuShortcut />
    </ContextMenuCheckboxItem>
    <ContextMenuRadioGroup>
      <ContextMenuLabel />
      <ContextMenuRadioItem />
    </ContextMenuRadioGroup>
  </ContextMenuContent>
</ContextMenu>

Bagian lain yang tersedia: ContextMenuGroup.

API Reference

ContextMenu

Prop	Type	Default	Description
pressOpenDelay?	number	—	The duration from when the trigger is pressed until the menu opens.
dir?	Direction$4	—	The reading direction of the combobox when applicable. If omitted, inherits globally from ConfigProvider or assumes LTR (left-to-right) reading mode.
modal?	boolean	—	The modality of the dropdown menu. When set to true, interaction with outside elements will be disabled and only menu content will be visible to screen readers.

Event	Payload	Description
@update:open	[payload: boolean]	Emitted when the open state changes.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu"

ContextMenuCheckboxItem

Prop	Type	Default	Description
modelValue?	CheckedState	—	The controlled checked state of the item. Can be used as v-model.
disabled?	boolean	—	When true, prevents the user from interacting with the item.
textValue?	string	—	Optional text used for typeahead purposes. By default the typeahead behavior will use the .textContent of the item. Use this when the content is complex, or you have non-textual content inside.
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.

Event	Payload	Description
@update:modelValue	[payload: boolean]	Emitted when the value changes.
@select	[event: Event]	Emitted when it is selected, by pointer or keyboard; call event.preventDefault() to keep the menu open.

Slot	Props
#indicator-icon	—
#default	—

Data attribute	Value
[data-slot]	"context-menu-checkbox-item"

ContextMenuContent

Prop	Type	Default	Description
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.
forceMount?	boolean	—	Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
loop?	boolean	—	When true, keyboard navigation will loop from last item to first, and vice versa.
reference?	ReferenceElement	—	The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.
memoDependencies?	unknown[]	—	Reactive dependencies that should invalidate the memoized content subtree.
sideFlip?	boolean	—	Flip to the opposite side when colliding with boundary.
alignOffset?	number	—	An offset in pixels from the start or end alignment options.
alignFlip?	boolean	—	Flip alignment when colliding with boundary. May only occur when prioritizePosition is true.
avoidCollisions?	boolean	—	When true, overrides the side and align preferences to prevent collisions with boundary edges.
collisionBoundary?	Element | (Element | null)[]	—	The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
collisionPadding?	number | Partial<Record<"bottom" | "top" | "right" | "left", number>>	—	The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
hideShiftedArrow?	boolean	—	When true, hides the arrow when it cannot be centered to the reference element.
sticky?	"partial" | "always"	—	The sticky behavior on the align axis. partial will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
hideWhenDetached?	boolean	—	Whether to hide the content when the trigger becomes fully occluded.
positionStrategy?	"fixed" | "absolute"	—	The type of CSS position property to use.
disableUpdateOnLayoutShift?	boolean	—	Whether to disable the update position for the content when the layout shifted.
prioritizePosition?	boolean	—	Force content to be position within the viewport. Might overlap the reference element, which may not be desired.

Event	Payload	Description
@escapeKeyDown	[event: KeyboardEvent]	Emitted when Escape is pressed; call event.preventDefault() to keep it open.
@pointerDownOutside	[event: PointerDownOutsideEvent]	Emitted on a pointer down outside; call event.preventDefault() to keep it open.
@focusOutside	[event: FocusOutsideEvent]	Emitted when focus moves outside; call event.preventDefault() to keep it open.
@interactOutside	[event: PointerDownOutsideEvent | FocusOutsideEvent]	Emitted on any pointer down or focus outside; call event.preventDefault() to keep it open.
@closeAutoFocus	[event: Event]	Emitted when focus returns on close; call event.preventDefault() to stop it.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-content"

ContextMenuGroup

Prop	Type	Default	Description
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-group"

ContextMenuItem

Prop	Type	Default	Description
disabled?	boolean	—	When true, prevents the user from interacting with the item.
textValue?	string	—	Optional text used for typeahead purposes. By default the typeahead behavior will use the .textContent of the item. Use this when the content is complex, or you have non-textual content inside.
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.
inset?	boolean	—	Adds left padding (pl-8) so the text lines up with items that have an icon or indicator.
variant?	"default" | "destructive"	"default"	The visual style.

Event	Payload	Description
@select	[event: Event]	Emitted when it is selected, by pointer or keyboard; call event.preventDefault() to keep the menu open.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-item"
[data-inset]	boolean
[data-variant]	"default" | "destructive"

ContextMenuLabel

Prop	Type	Default	Description
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.
inset?	boolean	—	Adds left padding (pl-8) so the text lines up with items that have an icon or indicator.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-label"
[data-inset]	boolean

ContextMenuRadioGroup

Prop	Type	Default	Description
modelValue?	AcceptableValue	—	The value of the selected item in the group.
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.

Event	Payload	Description
@update:modelValue	[payload: AcceptableValue]	Emitted when the value changes.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-radio-group"

ContextMenuRadioItem

Prop	Type	Default	Description
value	AcceptableValue	—	The unique value of the item.
disabled?	boolean	—	When true, prevents the user from interacting with the item.
textValue?	string	—	Optional text used for typeahead purposes. By default the typeahead behavior will use the .textContent of the item. Use this when the content is complex, or you have non-textual content inside.
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.

Event	Payload	Description
@select	[event: Event]	Emitted when it is selected, by pointer or keyboard; call event.preventDefault() to keep the menu open.

Slot	Props
#indicator-icon	—
#default	—

Data attribute	Value
[data-slot]	"context-menu-radio-item"

ContextMenuSeparator

Prop	Type	Default	Description
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.

Data attribute	Value
[data-slot]	"context-menu-separator"

ContextMenuShortcut

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-shortcut"

ContextMenuSub

Prop	Type	Default	Description
defaultOpen?	boolean	—	The open state of the submenu when it is initially rendered. Use when you do not need to control its open state.
open?	boolean	—	The controlled open state of the menu. Can be used as v-model:open.

Event	Payload	Description
@update:open	[payload: boolean]	Emitted when the open state changes.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-sub"

ContextMenuSubContent

Prop	Type	Default	Description
forceMount?	boolean	—	Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.
loop?	boolean	—	When true, keyboard navigation will loop from last item to first, and vice versa.
reference?	ReferenceElement	—	The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.
memoDependencies?	unknown[]	—	Reactive dependencies that should invalidate the memoized content subtree.
sideOffset?	number	—	The distance in pixels from the trigger.
sideFlip?	boolean	—	Flip to the opposite side when colliding with boundary.
alignOffset?	number	—	An offset in pixels from the start or end alignment options.
alignFlip?	boolean	—	Flip alignment when colliding with boundary. May only occur when prioritizePosition is true.
avoidCollisions?	boolean	—	When true, overrides the side and align preferences to prevent collisions with boundary edges.
collisionBoundary?	Element | (Element | null)[]	—	The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
collisionPadding?	number | Partial<Record<"bottom" | "top" | "right" | "left", number>>	—	The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
arrowPadding?	number	—	The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
hideShiftedArrow?	boolean	—	When true, hides the arrow when it cannot be centered to the reference element.
sticky?	"partial" | "always"	—	The sticky behavior on the align axis. partial will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
hideWhenDetached?	boolean	—	Whether to hide the content when the trigger becomes fully occluded.
positionStrategy?	"fixed" | "absolute"	—	The type of CSS position property to use.
updatePositionStrategy?	"always" | "optimized"	—	Strategy to update the position of the floating element on every animation frame.
disableUpdateOnLayoutShift?	boolean	—	Whether to disable the update position for the content when the layout shifted.
prioritizePosition?	boolean	—	Force content to be position within the viewport. Might overlap the reference element, which may not be desired.

Event	Payload	Description
@escapeKeyDown	[event: KeyboardEvent]	Emitted when Escape is pressed; call event.preventDefault() to keep it open.
@pointerDownOutside	[event: PointerDownOutsideEvent]	Emitted on a pointer down outside; call event.preventDefault() to keep it open.
@focusOutside	[event: FocusOutsideEvent]	Emitted when focus moves outside; call event.preventDefault() to keep it open.
@interactOutside	[event: PointerDownOutsideEvent | FocusOutsideEvent]	Emitted on any pointer down or focus outside; call event.preventDefault() to keep it open.
@openAutoFocus	[event: Event]	Emitted when focus moves in on open; call event.preventDefault() to stop it.
@closeAutoFocus	[event: Event]	Emitted when focus returns on close; call event.preventDefault() to stop it.
@entryFocus	[event: Event]	Emitted when focus enters the group; call event.preventDefault() to skip focusing the first item.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-sub-content"

ContextMenuSubTrigger

Prop	Type	Default	Description
disabled?	boolean	—	When true, prevents the user from interacting with the item.
textValue?	string	—	Optional text used for typeahead purposes. By default the typeahead behavior will use the .textContent of the item. Use this when the content is complex, or you have non-textual content inside.
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.
inset?	boolean	—	Adds left padding (pl-8) so the text lines up with items that have an icon or indicator.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-sub-trigger"
[data-inset]	boolean

ContextMenuTrigger

Prop	Type	Default	Description
disabled?	boolean	—	When true, the context menu would not open when right-clicking. Note that this will also restore the native context menu.
asChild?	boolean	—	Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
as?	AsTag | Component	—	The element or component this component should render as. Can be overwritten by asChild.

Slot	Props
#default	—

Data attribute	Value
[data-slot]	"context-menu-trigger"

Keyboard Interactions

Perilaku keyboard-nya datang dari primitif Reka UI ContextMenu yang dipakai komponen ini, mengikuti pola WAI-ARIA.

Key	Description
Space	Activates the focused item.
Enter	Activates the focused item.
ArrowDown	Moves focus to the next item.
ArrowUp	Moves focus to the previous item.
ArrowRight + ArrowLeft	When focus is on ContextMenu.SubTrigger, opens or closes the submenu depending on reading direction.
Esc	Closes the context menu

CSS Variables

Token tema yang dibaca komponen ini — ubah nilainya di CSS global (:root dan .dark, lihat Theming) untuk mengubah tampilannya tanpa menyentuh komponennya: --accent, --accent-foreground, --border, --destructive, --destructive-foreground, --foreground, --muted-foreground, --popover, --popover-foreground, --radius.

Credits

Berasal dari shadcn-vue (MIT, Copyright (c) 2023 unovue). Rantai lengkapnya di Credits.