umbraco-umbraco-element

Implement Umbraco backoffice Web Components using UmbElementMixin and UmbLitElement.

26|13|Updated Nov 30, 2025
One-click install
npx skills add https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills --skill umbraco-umbraco-element
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: umbraco-umbraco-element
Source: https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills/tree/main/plugins/umbraco-backoffice-skills/skills/umbraco-umbraco-element
Command: npx skills add https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills --skill umbraco-umbraco-element

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the process of implementing custom Web Components within the Umbraco Backoffice by leveraging the UmbElementMixin and UmbLitElement, enabling easier integration with Umbraco's context and localization features.

Core Features & Use Cases

  • Web Component Integration: Create custom elements that seamlessly integrate with the Umbraco Backoffice.
  • Context Management: Easily consume and provide contexts using consumeContext() and provideContext().
  • State Observation: Observe and react to changes in observable state with the observe() method.
  • Localization: Utilize built-in localization for multi-language support.
  • Use Case: Develop a custom dashboard widget that displays user-specific information by consuming the UMB_CURRENT_USER_CONTEXT and displaying the user's name.

Quick Start

Generate a new Umbraco element using UmbLitElement that displays a localized term for 'myKey' and consumes the MY_CONTEXT.

Frequently Asked Questions about umbraco-umbraco-element

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

FAQPage Schema
How do I create custom web components in the Umbraco backoffice?

To create custom Umbraco backoffice elements, build Lit-based web components using UmbElementMixin or UmbLitElement. This approach enables seamless integration with Umbraco's context APIs, controllers, and localization features.

How do I consume and provide context within an Umbraco element?

Manage context within an Umbraco element by using the built-in `consumeContext()` and `provideContext()` methods. These APIs allow your custom web components to easily interact with backoffice states like the current user context.

What is the best way to handle localization in Umbraco backoffice elements?

Handle localization in Umbraco backoffice elements by utilizing the built-in localization features provided by UmbElementMixin or UmbLitElement. This supports multi-language terms directly within your custom web components.

How do I observe state changes in an Umbraco Lit component?

Observe and react to changes in observable state within your Umbraco Lit component by using the `observe()` method. This function ensures your custom element updates automatically when underlying backoffice data changes.

Can I use UmbElementMixin to build a custom dashboard widget for Umbraco?

Yes, you can use UmbElementMixin to build a custom dashboard widget. For example, you can consume the `UMB_CURRENT_USER_CONTEXT` and display user-specific information like the user's name directly in the backoffice.