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_Appends 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"
}
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
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
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
Optionaloptions: UmbClassGetContextOptionsA 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
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
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.