Extension Kind

Learn how to use the Kind extension in your manifest files when extending the Umbraco CMS backoffice.

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.

Extension Manifest Kind enables declarations to be based upon a preset Manifest.

This is used for maintainability or to inherit existing features.

Manifest Kind Declaration

A Kind is utilized by declaring it in the kind field of a Manifest:

const manifest = {
    type: 'headerApp',
    kind: 'button',
    ...
};

By declaring a kind, the Manifest will inherit fields of the defined Kind.

A typical use case is a Kind that provides an element, but requires additional meta fields, to fulfill the needs of its element.

In the following example, a manifest using the type 'headerApp' utilizes the 'button' kind. This brings an element and requires some additional information as part of the meta object.

Adding the metadata provides the ability to use and configure existing functionality to a specific need.

const manifest = {
    type: 'headerApp',
    kind: 'button',
    name: 'My Header App Example',
    alias: 'My.HeaderApp.Example',
    meta: {
        label: 'My Example',
        icon: 'icon-home',
        href: '/some/path/to/open/when/clicked',
    },
};

Learn more

Learn more about Kinds and how to create your own:

Kind