pimcore-studio-ui-widgets

Register and manage Pimcore Studio UI widgets across layout areas.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Coordinated UI widget management across Pimcore Studio requires registries, navigation links, and layout wiring; this skill consolidates the patterns for registering widgets, opening them in specific areas, and binding them to navigation items.

Core Features & Use Cases

  • Register widgets with a WidgetRegistry and expose them via a component.
  • Open widgets in main, left, right, or bottom layout areas using the WidgetManager.
  • Configure singleton vs multi-instance widgets via WidgetManagerTabConfig and navigation integration.
  • Connect widgets to main navigation entries to enable quick access.

Quick Start

Register a new widget named "my-feature" and connect it to a navigation item to enable opening it from the main UI.

Frequently Asked Questions about pimcore-studio-ui-widgets

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

FAQPage Schema
How do I register a React widget in Pimcore Studio UI?

To register a React widget in Pimcore Studio UI, you need a registered widget name, a React component, and a config object. This registers the widget with the WidgetRegistry to enable modular interface integration.

How do I open a widget in specific layout areas like main, left, or right in Pimcore?

You can open widgets in main, left, right, or bottom layout areas using the WidgetManager. This allows you to position registered React components precisely within the Pimcore Studio interface.

How do I configure singleton versus multi-instance widgets in Pimcore Studio?

You configure singleton versus multi-instance widgets in Pimcore Studio using WidgetManagerTabConfig. This configuration object also manages tabs and integrates the widgets with navigation items for quick access.

How do I link a Pimcore Studio UI widget to the main navigation?

To link a Pimcore Studio UI widget to the main navigation, you connect the registered widget to a navigation entry. This binding exposes the widget directly in the main UI for quick access and visibility.

What configuration options are required to render a Pimcore Studio UI widget properly?

To render a Pimcore Studio UI widget properly, the config object may include a translationKey and an icon. Alongside a registered widget name and React component, these properties ensure correct display.