Creates an instance of UmbModalRouteRegistrationController.
The host element of the modal, this determine the ownership of the modal and the origin of it.
The alias of the modal, this is used to identify the modal.
OptionalctrlAlias: UmbControllerAliasThe alias for this controller, this is used to identify the controller.
Returns true if the modal is currently active.
Returns the modal context if the modal is currently active. Otherwise its undefined.
Protected_setAppends an additional path to the modal route.
This can help specify the URL for this modal, or used to add a parameter to the URL like this: "/modal/my-modal/:index/" A folder name starting with a colon ":" will be interpreted as a parameter. Then this modal can open with any value in that location. When modal is being setup the value of the parameter can be read from the route params. See the example:
The additional path to be appended to the modal route
this
const modalRegistration = new UmbModalRouteRegistrationController(this, MY_MODAL_TOKEN)
modalRegistration.addAdditionalPath(':index')
modalRegistration.onSetup((params) => {
const index = params.index;
// When entering the url of: "/modal/my-modal/hello-world/"
// Then index will be "hello-world"
}
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Optionaloptions: boolean | AddEventListenerOptionsRegisterer one or more additional paths to the modal route, similar to addAdditionalPath. But without defining the actual path name. This enables this to be asynchronously defined and even changed later. This can be useful if your modal has to be unique for this registration, avoiding collision with other registrations. If you made a modal for editing one of multiple property, then you can add a unique path holding the property id. Making the URL unique to this modal registration: /modal/my-modal/my-unique-value/
Notice the modal will only be available when all unique paths have a value.
the unique path names
this
const modalRegistration = new UmbModalRouteRegistrationController(this, MY_MODAL_TOKEN)
modalRegistration.addUniquePaths(['myAliasForIdentifyingThisPartOfThePath'])
// Later:
modalRegistration.setUniquePathValue('myAliasForIdentifyingThisPartOfThePath', 'myValue');
Callback method called when context is resolved.
Reference to the created Context Consumer Controller instance
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
A Promise with the reference to the Context Api Instance
An Observable to observe from.
Optionalcallback: ObserverCallback<SpecificT>Callback method called when data is changed.
OptionalcontrollerAlias: 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.
Optionalprepend: stringThe API instance to be exposed.
Reference to the created Context Provider Controller instance
Removes the event listener in target's event listener list with the same type, callback, and options.
Optionaloptions: boolean | EventListenerOptionsSet or change the value of a unique path part.
the unique path part identifier
the new value for the unique path part
This mixin enables a web-component to host controllers. This enables controllers to be added to the life cycle of this element.