Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Enterprise Open source

ContextMenuProps interface

Signature

typescript
export interface ContextMenuProps 

Import

typescript
import { ContextMenuProps } from '@grafana/ui';

Properties

PropertyTypeDescription
focusOnOpenbooleanOn menu open focus the first element
onClose() => voidCallback for closing the menu
renderHeader() => React.ReactNodeA function that returns header element
renderMenuItems() => React.ReactNodeRenderProp function that returns menu items to display
xnumberStarting horizontal position for the menu
ynumberStarting vertical position for the menu

focusOnOpen property

On menu open focus the first element

Signature

typescript
focusOnOpen?: boolean;

onClose property

Callback for closing the menu

Signature

typescript
onClose?: () => void;

renderHeader property

A function that returns header element

Signature

typescript
renderHeader?: () => React.ReactNode;

renderMenuItems property

RenderProp function that returns menu items to display

Signature

typescript
renderMenuItems?: () => React.ReactNode;

x property

Starting horizontal position for the menu

Signature

typescript
x: number;

y property

Starting vertical position for the menu

Signature

typescript
y: number;