vue-mvvm / alert / AlertControl
AlertControl
Abstract base class for implementing an universal Alert dialog.
Extends
Implements
Action<void>
Constructors
Constructor
new AlertControl(options): AlertControl;Parameters
options
Returns
AlertControl
Overrides
Properties
ctx
protected readonly ctx: ReadableGlobalContext;Represents a readonly global context that provides features like DI
Inherited from
description
readonly description: string;destroyed
readonly destroyed: boolean;Inherited from
options
protected readonly options: AlertOptions;title
readonly title: string;Methods
[asyncDispose]()
asyncDispose: Promise<void>;Returns
Promise<void>
Inherited from
[dispose]()
dispose: void;Returns
void
Inherited from
activated()
protected activated(): void | Promise<void>;Hook for Vue's onActivated
Returns
void | Promise<void>
Inherited from
beforeMount()
protected beforeMount(): void | Promise<void>;Hook for Vue's onBeforeMount
Returns
void | Promise<void>
Inherited from
beforeUnmount()
protected beforeUnmount(): void | Promise<void>;Hook for Vue's onBeforeUnmount
Returns
void | Promise<void>
Inherited from
beforeUpdate()
protected beforeUpdate(): void | Promise<void>;Hook for Vue's onBeforeUpdate
Returns
void | Promise<void>
Inherited from
closeDialog()
closeDialog(): Promise<void>;Requests the dialog to close, can be safely closed from the inheriting class for closing the dialog from the inside.
If the dialog has been destroyed, a warning is logged, and the method exits.
Returns
Promise<void>
Inherited from
computed()
Call Signature
protected computed<T>(getter): T;Type Parameters
T
T
Parameters
getter
ComputedGetter<T>
Returns
T
Inherited from
Call Signature
protected computed<T>(options): T;Type Parameters
T
T
Parameters
options
get
ComputedGetter<T>
set
ComputedSetter<T>
Returns
T
Inherited from
deactivated()
protected deactivated(): void | Promise<void>;Hook for Vue's onDeactivated
Returns
void | Promise<void>
Inherited from
destroy()
destroy(): void;Marks the current instance as destroyed. Additionally it will not longer be rendered by the DialogProvider
Returns
void
Inherited from
getUserControl()
protected getUserControl<T>(ref): T | null;Collect UserControl that are bound to the View using a Vue.js template ref
Type Parameters
T
T extends | UserControl | UserControl[]
Parameters
ref
string
The Vue.js Template ref
Returns
T | null
UserControl of the bounded UI Element
Inherited from
mounted()
protected mounted(): void | Promise<void>;Hook for Vue's onMounted
Returns
void | Promise<void>
Inherited from
onAction()
abstract onAction(ctx): void | Promise<void>;Called when the action execution is initiated by an external ViewModel via ViewModel.runAction.
This method receives a new ActionContext representing the current execution flow.
Parameters
ctx
ActionContext<void>
The context object specific to this execution run, used to resolve or fail the action.
Returns
void | Promise<void>
Remarks
It is semantically possible for this method to be called multiple times on the same instance (e.g., if the caller does not await the previous runAction call). Implementations should decide whether to support concurrent executions or replace the active context (last-one-wins).
Implementation of
onClose()
abstract protected onClose(): void | Promise<void>;Is executed when closing the dialog was requested
Returns
void | Promise<void>
Inherited from
onOpen()
abstract protected onOpen(): void | Promise<void>;Is executed when opening the dialog was requested
Returns
void | Promise<void>
Inherited from
openDialog()
openDialog(): Promise<void>;Requests the dialog to open
If the dialog has been destroyed, a warning is logged, and the method exits.
Returns
Promise<void>
Inherited from
readonly()
protected readonly<T>(value): T;Type Parameters
T
T
Parameters
value
T
Returns
T
Inherited from
ref()
protected ref<T>(initial): T;Type Parameters
T
T
Parameters
initial
T
Returns
T
Inherited from
runAction()
protected runAction<T>(action): Promise<ActionResult<T>>;Executes an MVVM Action and returns its result as a promise.
Notes
- The action body may be synchronous or asynchronous; both are supported.
- If the action tries to complete/fail more than once, a Vue warning is emitted and further attempts are ignored.
Type Parameters
T
T
Parameters
action
Action<T>
The action object implementing Action interface.
Returns
Promise<ActionResult<T>>
A promise that resolves with an ActionResult carrying either the data on success or an error on failure.
Inherited from
unmounted()
protected unmounted(): void | Promise<void>;Hook for Vue's onUnmounted
Returns
void | Promise<void>
Inherited from
updated()
protected updated(): void | Promise<void>;Hook for Vue's onUpdated
Returns
void | Promise<void>
Inherited from
watch()
protected watch(
source,
cb,
options?): WatchHandle;Sets up a watch on a reactive source and registers the watch handle. Allows tracking and managing the lifecycle of the watch handle within the class.
Additionally, watchers are automatically disposed after the component is unmounted and all lifecycle hooks have finished executing.
Parameters
source
WatchSource
The reactive source to watch.
cb
WatchCallback
The callback function that gets triggered when the source changes.
options?
WatchOptions<boolean>
Optional configuration object for the watcher (e.g., deep, immediate).
Returns
A custom watch handle with methods to stop, pause, and resume the watcher.