What is the Umbraco Context API?

It is a communication system in the Umbraco backoffice that enables extensions to share data and functionality through the component hierarchy using a provider-consumer pattern.

Can I define my own custom contexts?

Yes, this skill provides patterns for defining your own UmbContextToken and implementing provideContext() to share custom services with descendant elements.

When should I use the subscription pattern vs. the one-time pattern?

Use the subscription pattern (consumeContext) during component initialization when you need ongoing access. Use the one-time pattern (getContext) for specific actions, like handling a button click.

How do I ensure type safety with this skill?

This skill utilizes UmbContextTokens, which provide strongly-typed identifiers for contexts, ensuring that the services you access match your TypeScript definitions.

Umbraco Backoffice Context API

Name: Umbraco Backoffice Context API
Author: umbraco

byumbraco

•

Content Management

Implements the Umbraco Context API to enable type-safe, decoupled communication between backoffice components.

About

The Umbraco Context API skill provides specialized guidance for working with Umbraco's core communication system. It enables developers to implement the provider-consumer pattern within the Umbraco backoffice, allowing extensions to share data and functionality through the component hierarchy without tight coupling. By utilizing context tokens, this skill helps generate type-safe code for accessing essential services like notifications, user information, and workspaces, or for creating custom service architectures within Umbraco's modern web component-based UI.

Key Features

Supports integration with built-in Umbraco contexts like Notifications and Modals
Generates boilerplate for both subscription and one-time context access
Implements type-safe context provision and consumption patterns
Ensures adherence to Umbraco's hierarchical DOM-based communication standards
1 GitHub stars
Guides the creation of custom context tokens for bespoke service architectures

Use Cases

Accessing the Notification Context to show UI feedback in a custom property editor
Retrieving current user information or workspace data within a backoffice extension
Creating a custom context provider to share state across a complex workspace

About

Key Features

Supports integration with built-in Umbraco contexts like Notifications and Modals
Generates boilerplate for both subscription and one-time context access
Implements type-safe context provision and consumption patterns
Ensures adherence to Umbraco's hierarchical DOM-based communication standards
1 GitHub stars
Guides the creation of custom context tokens for bespoke service architectures

Use Cases

Accessing the Notification Context to show UI feedback in a custom property editor
Retrieving current user information or workspace data within a backoffice extension
Creating a custom context provider to share state across a complex workspace