Optional
alias: stringProtected
_The addEventListener()
method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Optional
options: boolean | AddEventListenerOptionsCancel all resources that are currently being executed by this controller if they are cancelable.
This works by checking if the promise is a CancelablePromise and if so, it will call the cancel method.
This is useful when the controller is being disconnected from the DOM.
Callback method called when context is resolved.
Reference to the created Context Consumer Controller instance
The dispatchEvent()
method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
Optional
options: UmbClassGetContextOptionsA Promise with the reference to the Context Api Instance
Internal
Maps any error to an UmbError.
The error to map
The mapped error
An Observable to observe from.
Optional
callback: ObserverCallback<SpecificT>Callback method called when data is changed.
Optional
controllerAlias: null | UmbControllerAliasDefine 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.
Reference to the created Observer Controller instance.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
The removeEventListener()
method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optional
options: boolean | EventListenerOptionsOptional
opts: UmbTryExecuteOptions
This mixin enables a web-component to host controllers. This enables controllers to be added to the life cycle of this element.