• Preparing search index...
  • The search index is not available
@umbraco-cms/backoffice
  • @umbraco-cms/backoffice
  • libs/extension-api
  • createExtensionElementWithApi

Function createExtensionElementWithApi

  • createExtensionElementWithApi<
        ElementType extends UmbControllerHostElement,
        ApiType extends UmbApi = UmbApi,
    >(
        manifest: ManifestElementAndApi<ElementType, ApiType>,
        constructorArgs?:
            | unknown[]
            | UmbApiConstructorArgumentsMethodType<
                ManifestElementAndApi<ElementType, ApiType>,
            >,
        fallbackElement?: string,
        fallbackApi?: ApiLoaderProperty<ApiType>,
    ): Promise<{ api?: ApiType; element?: ElementType }>

    Type Parameters

    • ElementType extends UmbControllerHostElement
    • ApiType extends UmbApi = UmbApi

    Parameters

    • manifest: ManifestElementAndApi<ElementType, ApiType>
    • OptionalconstructorArgs:
          | unknown[]
          | UmbApiConstructorArgumentsMethodType<
              ManifestElementAndApi<ElementType, ApiType>,
          >
    • OptionalfallbackElement: string
    • OptionalfallbackApi: ApiLoaderProperty<ApiType>

    Returns Promise<{ api?: ApiType; element?: ElementType }>

    • Returns an object with the created element and api.
    • Defined in src/libs/extension-api/functions/create-extension-element-with-api.function.ts:17

Settings

Member Visibility
@umbraco-cms/backoffice
  • Loading...

Generated using TypeDoc