@umbraco-cms/backoffice

    Interface ManifestBlockEditorCustomView

    interface ManifestBlockEditorCustomView {
        alias: string;
        element?: ElementLoaderProperty<
            UmbBlockEditorCustomViewElement<
                UmbBlockLayoutBaseModel,
                UmbBlockTypeBaseModel,
            >,
        >;
        ELEMENT_TYPE?: UmbBlockEditorCustomViewElement<
            UmbBlockLayoutBaseModel,
            UmbBlockTypeBaseModel,
        >;
        elementName?: string;
        forBlockEditor?: string
        | string[];
        forContentTypeAlias?: string | string[];
        js?: ElementLoaderProperty<
            UmbBlockEditorCustomViewElement<
                UmbBlockLayoutBaseModel,
                UmbBlockTypeBaseModel,
            >,
        >;
        kind?: unknown;
        meta?: unknown;
        name: string;
        type: "blockEditorCustomView";
        weight?: number;
    }

    Hierarchy (View Summary, Expand)

    Index

    Properties

    alias element? ELEMENT_TYPE? elementName? forBlockEditor? forContentTypeAlias? js? kind? meta? name type weight?

    Properties

    alias: string

    The alias of the extension, ensure it is unique

    element?: ElementLoaderProperty<
        UmbBlockEditorCustomViewElement<
            UmbBlockLayoutBaseModel,
            UmbBlockTypeBaseModel,
        >,
    >

    The file location of the element javascript file to load @TJS-type string

    ELEMENT_TYPE?: UmbBlockEditorCustomViewElement<
        UmbBlockLayoutBaseModel,
        UmbBlockTypeBaseModel,
    >

    @TJS-ignore

    elementName?: string

    The HTML web component name to use such as 'my-dashboard' Note it is NOT , just the element name.

    forBlockEditor?: string | string[]

    Optional condition if you like this custom view to only appear at a specific type of Block Editor.

    'block-list'

    ['block-list', 'block-grid', 'block-rte']
    forContentTypeAlias?: string | string[]

    Optional condition if you like this custom view to only appear at for one or more specific Content Types.

    'my-element-type-alias'

    ['my-element-type-alias-A', 'my-element-type-alias-B']
    js?: ElementLoaderProperty<
        UmbBlockEditorCustomViewElement<
            UmbBlockLayoutBaseModel,
            UmbBlockTypeBaseModel,
        >,
    >

    The file location of the javascript file to load @TJS-type string

    kind?: unknown

    The kind of the extension, used to group extensions together

    ["button"]

    meta?: unknown

    This contains properties specific to the type of extension

    name: string

    The friendly name of the extension

    type: "blockEditorCustomView"

    The type of extension such as dashboard etc...

    weight?: number

    Extensions such as dashboards are ordered by weight with lower numbers being first in the list

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR