pimcore-studio-ui-context-menus

Register and customize Pimcore Studio UI context menu items via ContextMenuRegistry slots.

13|Updated Apr 2, 2026
One-click install
npx skills add https://github.com/pimcore/skills --skill pimcore-studio-ui-context-menus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pimcore-studio-ui-context-menus
Source: https://github.com/pimcore/skills/tree/main/skills/pimcore-studio-ui-context-menus
Command: npx skills add https://github.com/pimcore/skills --skill pimcore-studio-ui-context-menus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Register and tailor Pimcore Studio UI context menus using a central registry, slots, and providers.

Core Features & Use Cases

  • Central ContextMenuRegistry registers items into slots, controlling priority, visibility, and the ability to override or hide built-in entries.
  • Providers implement ContextMenuItemProvider with a useMenuItem hook that returns a MenuItem object or null to hide.
  • Works across document, data object, and asset menus, enabling conditional display and placement relative to built-in items.

Quick Start

Register a new context menu item in the appropriate slot to extend the UI.

Frequently Asked Questions about pimcore-studio-ui-context-menus

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add custom context menu items to the Pimcore Studio UI?

To add custom context menu items in Pimcore Studio UI, you register them into specific slots using a central ContextMenuRegistry. You must implement a ContextMenuItemProvider with a useMenuItem hook that returns the MenuItem object to display.

Can I override or hide built-in context menu entries in Pimcore Studio?

Yes, you can override or hide built-in context menu entries in Pimcore Studio UI. By registering a provider with a unique name that returns null from the useMenuItem hook, you can conditionally hide default items and control their visibility.

Does Pimcore Studio UI context menu customization work for documents, data objects, and assets?

Pimcore Studio UI context menu customization applies across document, data object, and asset contexts. The ContextMenuRegistry allows you to register items into slots for tree, grid, and toolbar menus within all these specific resource types.

How do I control the display order of custom context menu items in Pimcore Studio?

You control the display order of custom context menu items in Pimcore Studio by setting a priority value during registration. The ContextMenuRegistry uses this priority to determine placement relative to other registered and built-in menu entries.

What is the useMenuItem hook used for when extending Pimcore Studio context menus?

The useMenuItem hook is used in Pimcore Studio context menu providers to produce MenuItem objects dynamically. Returning a MenuItem displays the entry, while returning null hides it, allowing conditional display logic based on the current context.