umbraco-context-api

The Umbraco Context API enables type-safe sharing of services and state across backoffice component hierarchies via a provider-consumer model using custom tokens. You provide data at a higher level so descendant extensions can consume it without tight coupling.

Use subscriptions for initialization-time context availability and one-time retrieval for user-triggered actions. Subscriptions ensure descendant components access built-in contexts like notifications during setup, while one-time lookups fetch data on demand.

Yes, the Context API integrates with built-in Umbraco contexts like notifications, current user, modal manager, document workspace, block entry, and property dataset. You consume these official contexts using standard context tokens within your extension hierarchy.

Use provideContext to cascade custom context tokens down the DOM hierarchy for downstream consumers. Define your custom token, provide it at a higher component level, and let descendant extensions retrieve it safely using consumeContext or getContext patterns.

TypeScript ensures type-safe sharing of services and state across Umbraco backoffice component hierarchies via the Context API. Following official documentation patterns for consumeContext, getContext, and provideContext requires TypeScript to maintain type safety with custom tokens.

Avoid the Context API when components need direct, immediate data exchange without hierarchical cascading, since the provider-consumer model relies on DOM hierarchy availability. For non-cascading data sharing or tightly coupled components, alternative dependency injection patterns may be more appropriate.