Class UmbExtensionElementInitializer<ManifestType, ControllerType, ExtensionInterface, ExtensionElementInterface>

This Controller manages a single Extension and its Element. When the extension is permitted to be used, its Element will be instantiated and available for the consumer.

Example

const controller = new UmbExtensionElementController(host, extensionRegistry, alias, (permitted, ctrl) => { console.log("Extension is permitted and this is the element: ", ctrl.component) }));

UmbExtensionElementController

Type Parameters

ManifestType extends ManifestWithDynamicConditions = ManifestWithDynamicConditions
ControllerType extends UmbExtensionElementInitializer<ManifestType, any> = any
ExtensionInterface extends ManifestElement = ManifestType extends ManifestElement ? ManifestType : never
ExtensionElementInterface extends HTMLElement | undefined = ExtensionInterface["ELEMENT_TYPE"]

Hierarchy (View Summary)

UmbBaseExtensionInitializer<ManifestType, ControllerType>
- UmbExtensionElementInitializer

Constructors

constructor

new UmbExtensionElementInitializer<
    ManifestType extends
        ManifestWithDynamicConditions<UmbConditionConfigBase<string>> = ManifestWithDynamicConditions<
        UmbConditionConfigBase<string>,
    >,
    ControllerType extends
        UmbExtensionElementInitializer<
            ManifestType,
            any,
            ManifestType extends ManifestElement<HTMLElement>
                ? ManifestType<ManifestType>
                : never,
            (
                ManifestType extends ManifestElement<HTMLElement>
                    ? ManifestType<ManifestType>
                    : never
            )["ELEMENT_TYPE"],
        > = any,
    ExtensionInterface extends
        ManifestElement<HTMLElement> = ManifestType extends ManifestElement<
        HTMLElement,
    >
        ? ManifestType<ManifestType>
        : never,
    ExtensionElementInterface extends
        undefined
        | HTMLElement = ExtensionInterface["ELEMENT_TYPE"],
>(
    host: UmbControllerHost,
    extensionRegistry: UmbExtensionRegistry<ManifestCondition>,
    alias: string,
    onPermissionChanged: (
        isPermitted: boolean,
        controller: ControllerType,
    ) => void,
    defaultElement?: string,
): UmbExtensionElementInitializer<
    ManifestType,
    ControllerType,
    ExtensionInterface,
    ExtensionElementInterface,
>
Type Parameters
- ManifestType extends ManifestWithDynamicConditions<UmbConditionConfigBase<string>> = ManifestWithDynamicConditions<UmbConditionConfigBase<string>>
- ControllerType extends UmbExtensionElementInitializer<
      ManifestType,
      any,
      ManifestType extends ManifestElement<HTMLElement>
          ? ManifestType<ManifestType>
          : never,
      (
          ManifestType extends ManifestElement<HTMLElement>
              ? ManifestType<ManifestType>
              : never
      )["ELEMENT_TYPE"],
  > = any
- ExtensionInterface extends ManifestElement<HTMLElement> = ManifestType extends ManifestElement<HTMLElement>
  ? ManifestType<ManifestType>
  : never
- ExtensionElementInterface extends undefined | HTMLElement = ExtensionInterface["ELEMENT_TYPE"]
Parameters
- host: UmbControllerHost
- extensionRegistry: UmbExtensionRegistry<ManifestCondition>
- alias: string
- onPermissionChanged: (isPermitted: boolean, controller: ControllerType) => void
- OptionaldefaultElement: string
Returns UmbExtensionElementInitializer<
    ManifestType,
    ControllerType,
    ExtensionInterface,
    ExtensionElementInterface,
>
Overrides UmbBaseExtensionInitializer.constructor
- Defined in src/libs/extension-api/controller/extension-element-initializer.controller.ts:58

Properties

_host

_host: UmbControllerHost

`Protected` `Optional`_isConditionsPositive

_isConditionsPositive?: boolean

Accessors

alias

get alias(): string
Returns string
Inherited from UmbBaseExtensionInitializer.alias
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:46

component

get component(): undefined | ExtensionElementInterface
The component that is created for this extension.

Returns undefined | ExtensionElementInterface
- Defined in src/libs/extension-api/controller/extension-element-initializer.controller.ts:30

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbBaseExtensionInitializer.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

manifest

get manifest(): undefined | ManifestType
Returns undefined | ManifestType
Inherited from UmbBaseExtensionInitializer.manifest
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:42

overwrites

get overwrites(): string[]
Returns string[]
Inherited from UmbBaseExtensionInitializer.overwrites
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:50

permitted

get permitted(): boolean
Returns boolean
Inherited from UmbBaseExtensionInitializer.permitted
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:38

properties

get properties(): undefined | Record<string, unknown>
Returns undefined | Record<string, unknown>
- Defined in src/libs/extension-api/controller/extension-element-initializer.controller.ts:49
set properties(newVal: undefined | Record<string, unknown>): void
Parameters
- newVal: undefined | Record<string, unknown>
Returns void
- Defined in src/libs/extension-api/controller/extension-element-initializer.controller.ts:52

weight

get weight(): number
Returns number
Inherited from UmbBaseExtensionInitializer.weight
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:34

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbBaseExtensionInitializer.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbBaseExtensionInitializer.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

asPromise

asPromise(): Promise<void>
Returns Promise<void>
Inherited from UmbBaseExtensionInitializer.asPromise
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:95

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbBaseExtensionInitializer.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Overrides UmbBaseExtensionInitializer.destroy
- Defined in src/libs/extension-api/controller/extension-element-initializer.controller.ts:109

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbBaseExtensionInitializer.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

equal

equal(
    otherClass:
        | undefined
        | UmbBaseExtensionInitializer<
            ManifestWithDynamicConditions<UmbConditionConfigBase<string>>,
            never,
        >,
): boolean
Parameters
- otherClass:
      | undefined
      | UmbBaseExtensionInitializer<
          ManifestWithDynamicConditions<UmbConditionConfigBase<string>>,
          never,
      >
Returns boolean
Inherited from UmbBaseExtensionInitializer.equal
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:302

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbBaseExtensionInitializer.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbBaseExtensionInitializer.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbBaseExtensionInitializer.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

hasConditions

hasConditions(): Promise<boolean>
Returns Promise<boolean>
Inherited from UmbBaseExtensionInitializer.hasConditions
- Defined in src/libs/extension-api/controller/base-extension-initializer.controller.ts:54

hasUmbController

hasUmbController(controller: UmbController): boolean
Parameters
- controller: UmbController
Returns boolean
Inherited from UmbBaseExtensionInitializer.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

hostConnected(): void
Returns void
Inherited from UmbBaseExtensionInitializer.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbBaseExtensionInitializer.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbBaseExtensionInitializer.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbBaseExtensionInitializer.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbBaseExtensionInitializer.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbBaseExtensionInitializer.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbBaseExtensionInitializer.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

Class UmbExtensionElementInitializer<ManifestType, ControllerType, ExtensionInterface, ExtensionElementInterface>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbExtensionElementInitializer< ManifestType, ControllerType, ExtensionInterface, ExtensionElementInterface,>

Properties

_host

Protected Optional_isConditionsPositive

Accessors

alias

Returns string

component

Returns undefined | ExtensionElementInterface

controllerAlias

Returns UmbControllerAlias

manifest

Returns undefined | ManifestType

overwrites

Returns string[]

permitted

Returns boolean

properties

Returns undefined | Record<string, unknown>

Parameters

Returns void

weight

Returns number

Methods

Protected_conditionsAreBad

Returns Promise<void>

Protected_conditionsAreGood

Returns Promise<boolean>

Protected_init

Returns void

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

asPromise

Returns Promise<void>

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

equal

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getUmbControllers

Parameters

Returns UmbController[]

hasConditions

Returns Promise<boolean>

hasUmbController

Parameters

Returns UmbExtensionElementInitializer<
ManifestType,
ControllerType,
ExtensionInterface,
ExtensionElementInterface,
>

`Protected` `Optional`_isConditionsPositive

`Protected`_conditionsAreBad

`Protected`_conditionsAreGood

`Protected`_init