@umbraco-cms/backoffice
    Preparing search index...

    Interface ManifestBlockAction<MetaType>

    Manifest for a block action extension. Block actions appear in the action bar of block entries (Block List, Block Grid, Block RTE, Block Single) and can be registered by both internal and third-party extensions. Use forBlockEditor and forContentTypeAlias to filter which blocks the action appears on.

    interface ManifestBlockAction<
        MetaType extends MetaBlockAction = MetaBlockAction,
    > {
        alias: string;
        api?: ApiLoaderProperty<UmbBlockAction<MetaType>>;
        API_TYPE?: UmbBlockAction<MetaType>;
        conditions?: (
            | UmbCoreConditionConfigs
            | UmbEntityUniqueConditionConfig
            | UmbEntityTypeConditionConfig
            | UmbLanguageUserPermissionConditionConfig
            | WorkspaceAliasConditionConfig
            | UmbWorkspaceEntityIsNewConditionConfig
            | UmbWorkspaceEntityTypeConditionConfig
            | UmbContentWorkspaceIsLoadedConditionConfig
            | UmbPropertyHasValueConditionConfig
            | UmbWorkspaceContentTypeAliasConditionConfig
            | UmbWorkspaceContentTypeUniqueConditionConfig
            | UmbEntityContentTypeUniqueConditionConfig
            | UmbIsRoutableContextConditionConfig
            | SectionAliasConditionConfig
            | UmbSectionUserPermissionConditionConfig
            | CollectionAliasConditionConfig
            | UmbCollectionHasItemsConditionConfig
            | UmbCurrentUserGroupIdConditionConfig
            | UmbIsAdminConditionConfig
            | UmbIsServerProductionModeConditionConfig
            | UmbUserConditionConfigs
            | UmbFallbackUserPermissionConditionConfig
            | UmbInModalConditionConfig
            | UmbEntityIsNotTrashedConditionConfig
            | UmbEntityIsTrashedConditionConfig
            | BlockEntryShowContentEditConditionConfig
            | BlockWorkspaceHasSettingsConditionConfig
            | BlockEntryIsExposedConditionConfig
            | BlockWorkspaceIsReadOnlyConditionConfig
            | BlockEntryIsReadOnlyConditionConfig
            | BlockEntryHasSettingsConditionConfig
            | UmbBlockEntryIsExposedConditionConfig
            | UmbWorkspaceHasContentCollectionConditionConfig
            | UmbDocumentUserPermissionConditionConfig
            | UmbDocumentPropertyValueUserPermissionConditionConfig
            | UmbEntityHasChildrenConditionConfig
        )[];
        element?: ElementLoaderProperty<UmbBlockActionElement>;
        ELEMENT_TYPE?: UmbBlockActionElement;
        elementName?: string;
        forBlockEditor?: string | string[];
        forContentTypeAlias?: string | string[];
        js?: ElementAndApiLoaderProperty<
            UmbBlockActionElement,
            UmbBlockAction<MetaType>,
        >;
        kind?: unknown;
        meta: MetaType;
        name: string;
        overwrites?: string | string[];
        type: "blockAction";
        weight?: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    alias api? API_TYPE? conditions? element? ELEMENT_TYPE? elementName? forBlockEditor? forContentTypeAlias? js? kind? meta name overwrites? type weight?

    Properties

    alias: string

    The alias of the extension, ensure it is unique

    api?: ApiLoaderProperty<UmbBlockAction<MetaType>>

    The file location of the api javascript file to load

    string

    API_TYPE?: UmbBlockAction<MetaType>
    conditions?: (
        | UmbCoreConditionConfigs
        | UmbEntityUniqueConditionConfig
        | UmbEntityTypeConditionConfig
        | UmbLanguageUserPermissionConditionConfig
        | WorkspaceAliasConditionConfig
        | UmbWorkspaceEntityIsNewConditionConfig
        | UmbWorkspaceEntityTypeConditionConfig
        | UmbContentWorkspaceIsLoadedConditionConfig
        | UmbPropertyHasValueConditionConfig
        | UmbWorkspaceContentTypeAliasConditionConfig
        | UmbWorkspaceContentTypeUniqueConditionConfig
        | UmbEntityContentTypeUniqueConditionConfig
        | UmbIsRoutableContextConditionConfig
        | SectionAliasConditionConfig
        | UmbSectionUserPermissionConditionConfig
        | CollectionAliasConditionConfig
        | UmbCollectionHasItemsConditionConfig
        | UmbCurrentUserGroupIdConditionConfig
        | UmbIsAdminConditionConfig
        | UmbIsServerProductionModeConditionConfig
        | UmbUserConditionConfigs
        | UmbFallbackUserPermissionConditionConfig
        | UmbInModalConditionConfig
        | UmbEntityIsNotTrashedConditionConfig
        | UmbEntityIsTrashedConditionConfig
        | BlockEntryShowContentEditConditionConfig
        | BlockWorkspaceHasSettingsConditionConfig
        | BlockEntryIsExposedConditionConfig
        | BlockWorkspaceIsReadOnlyConditionConfig
        | BlockEntryIsReadOnlyConditionConfig
        | BlockEntryHasSettingsConditionConfig
        | UmbBlockEntryIsExposedConditionConfig
        | UmbWorkspaceHasContentCollectionConditionConfig
        | UmbDocumentUserPermissionConditionConfig
        | UmbDocumentPropertyValueUserPermissionConditionConfig
        | UmbEntityHasChildrenConditionConfig
    )[]

    Set the conditions for when the extension should be loaded

    element?: ElementLoaderProperty<UmbBlockActionElement>

    The file location of the element javascript file to load

    string

    ELEMENT_TYPE?: UmbBlockActionElement
    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 filter to only show this action for specific Block Editors.

    'block-list'

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

    Optional filter to only show this action for specific Content Types by alias.

    'my-element-type-alias'

    ['my-element-type-alias-A', 'my-element-type-alias-B']
    js?: ElementAndApiLoaderProperty<
        UmbBlockActionElement,
        UmbBlockAction<MetaType>,
    >

    The file location of the javascript file to load

    string

    kind?: unknown

    The kind of the extension, used to group extensions together

    ["button"]

    meta: MetaType
    name: string

    The friendly name of the extension

    overwrites?: string | string[]

    Define one or more extension aliases that this extension should overwrite.

    type: "blockAction"

    The type of extension such as dashboard etc...

    weight?: number

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

    Settings

    Member Visibility

    On This Page

    Properties