@toolbox-web/grid 1.26.2 → 1.27.0

package/lib/plugins/context-menu/ContextMenuPlugin.d.ts

@@ -157,18 +157,37 @@ export declare class ContextMenuPlugin extends BaseGridPlugin<ContextMenuConfig>
     onKeyDown(event: KeyboardEvent): boolean | void;
     /**
      * Programmatically show the context menu at the specified position.
-     * @param x - X coordinate
-     * @param y - Y coordinate
-     * @param params - Partial context menu parameters
+     *
+     * Use this to open the menu from custom UI elements or keyboard shortcuts
+     * without requiring a native `contextmenu` event.
+     *
+     * @param x - Viewport X coordinate (pixels)
+     * @param y - Viewport Y coordinate (pixels)
+     * @param params - Partial context menu parameters — unspecified fields receive sensible defaults
+     *
+     * @example
+     * ```ts
+     * const menu = grid.getPluginByName('context-menu');
+     * // Open menu at a button's position with row context
+     * const rect = button.getBoundingClientRect();
+     * menu.showMenu(rect.left, rect.bottom, {
+     *   row: selectedRow,
+     *   rowIndex: 3,
+     *   column: columns[0],
+     * });
+     * ```
      */
     showMenu(x: number, y: number, params: Partial<ContextMenuParams>): void;
     /**
-     * Hide the context menu.
+     * Hide the context menu if it is currently open.
+     *
+     * Safe to call even when the menu is already closed.
      */
     hideMenu(): void;
     /**
      * Check if the context menu is currently open.
-     * @returns Whether the menu is open
+     *
+     * @returns `true` when the menu is visible
      */
     isMenuOpen(): boolean;
 }