pimcore-studio-ui-navigation

Register Pimcore Studio UI navigation items with perspective-based visibility.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Pimcore Studio requires coordinated frontend navigation and backend permissions. This skill provides a structured approach to register navigation items with perspective-based visibility and proper gating across modules. It covers how to connect new navigation items to perspectives, set up backend permissions, and configure translations.

Core Features & Use Cases

  • Registering main navigation items (frontend)
  • perspectivePermission field and relation to perspectives
  • Backend perspective permission registration (PHP)
  • StudioContextPermissionsSubscriber pattern
  • Translation keys for navigation and perspective editor
  • Permission groups and naming conventions

Quick Start

Register a new main navigation item and configure its translation and perspective permission in your Pimcore Studio feature module.

Frequently Asked Questions about pimcore-studio-ui-navigation

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

FAQPage Schema
How do I register navigation items with perspective-based visibility in Pimcore Studio?

To register Pimcore Studio navigation items with perspective-based visibility, use the MainNavRegistry for frontend registration and StudioContextPermissionsSubscriber for backend permission gating across modules and bundles.

What is the StudioContextPermissionsSubscriber pattern used for in Pimcore Studio?

The StudioContextPermissionsSubscriber pattern is used for backend perspective permission registration in PHP, ensuring that frontend navigation items displayed via MainNavRegistry are properly gated by corresponding backend permissions across Pimcore modules and bundles.

How do I configure translation keys for Pimcore Studio navigation and perspective editor?

Configure Pimcore Studio navigation and perspective editor translation keys by defining entries that correspond to your registered navigation items and perspective editor keys, ensuring proper localization and naming conventions within your feature module.

Can I control feature visibility per perspective across multiple Pimcore bundles?

Yes, you can control feature visibility per perspective across multiple Pimcore bundles by applying perspective-based visibility through coordinated frontend registration and backend permission groups, enabling granular access control for each distinct module.

Why does my Pimcore Studio navigation item show up without proper permission gating?

Pimcore Studio navigation items appear without proper permission gating when frontend registration via MainNavRegistry is not coordinated with backend perspective permission registration using StudioContextPermissionsSubscriber and the correct perspectivePermission field.

Do I need to set up permission groups when adding navigation items to Pimcore Studio?

Yes, setting up permission groups and following naming conventions is required when adding navigation items to Pimcore Studio, as backend permissions must be registered alongside frontend navigation items to enforce perspective-based visibility correctly.