Extension Registry

This page is a work in progress. It will be updated as the software evolves.

Most of BackOffice is based on Extensions making it crucial to understand how to register your own extensions. This introduction will give you an outline of the abilities of the extension registry.

The extension registry is a global registry that can be accessed and changed at anytime while Backoffice is running.

To provide new UI to backoffice, you need to register them via an extension manifest. This has to initially happen on the server, via a JSON Package Manifest. This will enable you to register one or more extensions.

The abilities of the extensions rely on the specific extension type. The Type sets the scene for what the extension can do and what it needs to be utilized.

Some extension types rely on a reference to other extensions.

Most extension types support conditions. Defining conditions enables you to control when and where the extension is available.

The kinds feature enables you to base your extension registration on a preset. A kind provides the base manifest that you like to extend.

import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';

A Package is declared via an Umbraco Package Manifest. This describes the Package and declares one or more UI Extensions.

Last updated