import {
  ContextMenu,
  ContextMenuGroup,
  ContextMenuRadioGroup,
  ContextMenuCheckboxGroup,
  ContextMenuItem,
} from "wis/contextMenu"

API Reference#

ContextMenu#

Name	Type	Default	Description
disabled	boolean	false	When true, prevents the user from interacting with the context menu.

ContextMenuGroup#

Name	Type	Default	Description
title	string	none	The group title text will show at the beginning of the group.
onSelect	(value: string) => void	none	Event handler called when group item click.

ContextMenuRadioGroup#

Name	Type	Default	Description
name	string	none	The unique name of group.
title	string	none	The group title text will show at the beginning of the group.
value	string	none	The value of selected item in the group. Must be used in conjunction with onChecked.
defaultValue	string	none	The default value of selected item in the group.
onChange	(value: string) => void	none	Event handler called when group item click.

ContextMenuCheckboxGroup#

Name	Type	Default	Description
name	string	none	The unique name of group.
title	string	none	The group title text will show at the beginning of the group.
value	string[]	none	The value of selected item in the group. Must be used in conjunction with onChange.
defaultValue	string[]	none	The default value of selected item in the group.
onChange	(value: string[]) => void	none	Event handler called when group item click.

ContextMenuItem#

Name	Type	Default	Description
label	string	none	The text information displayed on the item.
value	string	none	The unique value of the item.
status	danger	none	Sets the special status of the item.
disabled	boolean	false	When true, prevents the user from interacting with the context menu item.
icon	ReactNode	none	The icon element will be displayed next to the context menu item text.
shortcutKey	string	none	Sets a global shortcut key, such as Control+I. When the user presses the combination key, the context menu item's click event will be triggered. View Keyboard
onClick	(event: Event) => void	none	Event handler called when the user select an item (via mouse or keyboard).