pimcore-studio-ui-error-handling

Centralize Pimcore Studio UI error handling with trackError, ApiError, GeneralError, and ErrorBoundary.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Error handling in Pimcore Studio UI is currently scattered. This Skill consolidates patterns to report, wrap, and render errors consistently using trackError, ApiError, GeneralError, and ErrorBoundary.

Core Features & Use Cases

  • Centralized error reporting via trackError with ApiError and GeneralError wrappers.
  • Use of ErrorBoundary to catch render errors, with guidance not to wrap the widget root because the container provides an ErrorBoundary.
  • RTK Query error handling pattern: useEffect-based handling of error state, deduplication, and avoiding the unwrap approach to ensure consistent UX and centralized tracking.

Quick Start

Implement centralized error handling in Pimcore Studio UI by wiring trackError with ApiError/GeneralError and wrapping isolated components with ErrorBoundary.

Frequently Asked Questions about pimcore-studio-ui-error-handling

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

FAQPage Schema
How do I centralize error handling in Pimcore Studio UI?

Centralize error handling in Pimcore Studio UI by standardizing the use of trackError with ApiError, GeneralError, and ErrorBoundary to ensure consistent reporting and deduplicated alerts across render-time and non-API failures.

What is the best way to handle RTK Query errors in Pimcore Studio UI?

The best way to handle RTK Query errors is using a useEffect-based pattern to process error state, avoiding the unwrap approach to ensure consistent UX and centralized tracking via trackError.

Why should I avoid using unwrap with RTK Query for error handling?

Avoiding unwrap with RTK Query prevents inconsistent error states and bypassed tracking, enabling a useEffect-based pattern that deduplicates alerts and centralizes error reporting through trackError.

Do I need to wrap the widget root with an ErrorBoundary in Pimcore Studio UI?

You do not need to wrap the widget root with an ErrorBoundary because the container already provides one, but explicit ErrorBoundary components are required for isolated UI components to catch render errors.

When should I use ApiError versus GeneralError in Pimcore Studio UI?

Use ApiError to wrap API-related failures and GeneralError for non-API failures, routing both through trackError to maintain a consistent user experience and deduplicate alerts across the application.

Does Pimcore Studio UI error handling support isolated component render errors?

Pimcore Studio UI error handling supports isolated component render errors by requiring explicit ErrorBoundary wrappers around specific components, preventing render-time failures from crashing the entire application.