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

    Interface ManifestEntityCollectionItemRef<MetaType>

    interface ManifestEntityCollectionItemRef<
        MetaType extends
            MetaEntityCollectionItemRef = MetaEntityCollectionItemRef,
    > {
        alias: string;
        conditions?: (
            | UmbCoreConditionConfigs
            | UmbEntityUniqueConditionConfig
            | UmbEntityTypeConditionConfig
            | UmbLanguageUserPermissionConditionConfig
            | WorkspaceAliasConditionConfig
            | UmbWorkspaceEntityIsNewConditionConfig
            | UmbWorkspaceEntityTypeConditionConfig
            | UmbPropertyHasValueConditionConfig
            | UmbWorkspaceContentTypeAliasConditionConfig
            | UmbWorkspaceContentTypeUniqueConditionConfig
            | SectionAliasConditionConfig
            | UmbSectionUserPermissionConditionConfig
            | CollectionAliasConditionConfig
            | UmbCurrentUserGroupIdConditionConfig
            | UmbIsAdminConditionConfig
            | UmbUserConditionConfigs
            | UmbEntityIsNotTrashedConditionConfig
            | UmbEntityIsTrashedConditionConfig
            | BlockEntryShowContentEditConditionConfig
            | BlockWorkspaceHasSettingsConditionConfig
            | BlockEntryIsExposedConditionConfig
            | UmbWorkspaceHasContentCollectionConditionConfig
            | UmbDocumentUserPermissionConditionConfig
            | UmbDocumentPropertyValueUserPermissionConditionConfig
            | UmbFallbackUserPermissionConditionConfig
            | UmbEntityHasChildrenConditionConfig
        )[];
        element?: ElementLoaderProperty<UmbEntityCollectionItemElement>;
        ELEMENT_TYPE?: UmbEntityCollectionItemElement;
        elementName?: string;
        forEntityTypes: string[];
        js?: ElementLoaderProperty<UmbEntityCollectionItemElement>;
        kind?: unknown;
        meta?: MetaType;
        name: string;
        overwrites?: string | string[];
        type: "entityCollectionItemRef";
        weight?: number;
    }

    Type Parameters

    Hierarchy

    • ManifestEntityCollectionItemBase<MetaType>
      • ManifestEntityCollectionItemRef
    Index

    Properties

    alias conditions? element? ELEMENT_TYPE? elementName? forEntityTypes js? kind? meta? name overwrites? type weight?

    Properties

    alias: string

    The alias of the extension, ensure it is unique

    conditions?: (
        | UmbCoreConditionConfigs
        | UmbEntityUniqueConditionConfig
        | UmbEntityTypeConditionConfig
        | UmbLanguageUserPermissionConditionConfig
        | WorkspaceAliasConditionConfig
        | UmbWorkspaceEntityIsNewConditionConfig
        | UmbWorkspaceEntityTypeConditionConfig
        | UmbPropertyHasValueConditionConfig
        | UmbWorkspaceContentTypeAliasConditionConfig
        | UmbWorkspaceContentTypeUniqueConditionConfig
        | SectionAliasConditionConfig
        | UmbSectionUserPermissionConditionConfig
        | CollectionAliasConditionConfig
        | UmbCurrentUserGroupIdConditionConfig
        | UmbIsAdminConditionConfig
        | UmbUserConditionConfigs
        | UmbEntityIsNotTrashedConditionConfig
        | UmbEntityIsTrashedConditionConfig
        | BlockEntryShowContentEditConditionConfig
        | BlockWorkspaceHasSettingsConditionConfig
        | BlockEntryIsExposedConditionConfig
        | UmbWorkspaceHasContentCollectionConditionConfig
        | UmbDocumentUserPermissionConditionConfig
        | UmbDocumentPropertyValueUserPermissionConditionConfig
        | UmbFallbackUserPermissionConditionConfig
        | UmbEntityHasChildrenConditionConfig
    )[]

    Set the conditions for when the extension should be loaded

    element?: ElementLoaderProperty<UmbEntityCollectionItemElement>

    The file location of the element javascript file to load

    string

    ELEMENT_TYPE?: UmbEntityCollectionItemElement
    elementName?: string

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

    forEntityTypes: string[]

    The entity types this collection item supports.

    js?: ElementLoaderProperty<UmbEntityCollectionItemElement>

    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

    Additional metadata for the collection item.

    name: string

    The friendly name of the extension

    overwrites?: string | string[]

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

    type: "entityCollectionItemRef"

    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