Header Apps

Example how to work with extension registry

This page is a work in progress and may undergo further revisions, updates, or amendments. The information contained herein is subject to change without notice.

A header app appears next to the user profile and global search icon on the top-right corner of Umbraco's backoffice.

In this article, you can find an example of an extension registry. This example details the creation of a Header App in two ways, similar to how the extension registry can be created:

1. Using a manifest file.

2. Using the JavaScript/TypeScript file.

Header Apps

Button Header App with Manifest

Below you can find an example of how to setup a Header App using the manifest file.

1. Follow the Vite Package Setup to create a header app and name it "header-app" when using the guide.

2. Create a manifest file named umbraco-package.json at the root of the header-app folder. Here we define and configure our dashboard.

3. Add the following code to umbraco-package.json:

umbraco-package.json

{
  "$schema": "../../umbraco-package-schema.json",
  "name": "My Header App",
  "version": "0.1.0",
  "extensions": [
    {
      "type": "headerApp",
      "alias": "My.HeaderApp",
      "name": "My Header App",
      "kind": "button",

      "meta": {
        "label": "Hello Umbraco",
        "icon": "icon-hearts",
        "href": "https://umbraco.com/"
      }
    }
  ]
}

• First we define the type which is a headerApp. Then we add a unique alias and a name to define the extension UI.

• Then we can define what kind of extension it is, where in this case we can use a pre-defined element called button.

• The button requires some metdata: an icon, label of the button (name of the button) and a link which opens once clicked.

1. In the header-app folder run npm run build and then run the project. Then in the backoffice you will see our new Header App extension with heart icon:

Header App in the Backoffice registered via Manifest File

Button Header App with JS/TS

Below you can find an example of how to setup a Header App using the TypeScript file.

This is a continuation of the above steps from the Button Header App with Manifest example. We will register a new Header App directly from the .ts file.

1. Add a reference to the .js file. Update the umbraco-package.json with the following:

umbraco-package.json

{
  "$schema": "../../umbraco-package-schema.json",
  "name": "My Header App",
  "version": "0.1.0",
  "extensions": [
    {
      "type": "headerApp",
      "alias": "My.HeaderApp",
      "name": "My Header App",
      "kind": "button",
      "element": "/App_Plugins/header-app/dist/header-app.js",
      "meta": {
        "label": "Hello Umbraco",
        "icon": "icon-hearts",
        "href": "https://umbraco.com/"
      }
    }
  ]
}

1. Replace the content of the src/my-element.ts file with the following:

my-element.ts

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

const manifest: ManifestHeaderAppButtonKind = {
  type: "headerApp",
  alias: "My.HeaderApp.Documentation",
  name: "My Header App Documentation",
  kind: "button",
  meta: {
    label: "Hello Documentation",
    icon: "icon-addressbook",
    href: "https://docs.umbraco.com/"
  }
};

umbExtensionsRegistry.register(manifest);

1. In the header-app folder run npm run build and then run the project. Then in the backoffice you will see our new Header App extension with address book icon:

Header App in Backoffice registered via ts File