Class Dialogs

Represents an implementation of IDialogs.

Hierarchy (View Summary)

IDialogs
- Dialogs

Index

Constructors

Methods

show showBusyIndicator showConfirmation

Constructors

constructor

new Dialogs(
_dialogMediatorHandler: IDialogMediatorHandler,
dialogComponents: IDialogComponents,
): Dialogs
Initializes a new instance of the Dialogs class.
Parameters
- _dialogMediatorHandler: IDialogMediatorHandler
- dialogComponents: IDialogComponents
Returns Dialogs
Overrides IDialogs.constructor
- Defined in dialogs/Dialogs.ts:18

Methods

show

show<TRequest extends object, TResponse = object>(
request: TRequest,
): Promise<DialogResponse<TResponse>>
Show a dialog in the context of the current view and view model. This requires the view to host the dialog.
Type Parameters
- TRequest extends object
- TResponse = object
Parameters
- request: TRequest
  The input to pass to the dialog.
Returns Promise<DialogResponse<TResponse>>
The output from the dialog.
Overrides IDialogs.show
- Defined in dialogs/Dialogs.ts:41

showBusyIndicator

showBusyIndicator(title: string, message: string): BusyIndicator
Show a standard busy indicator dialog.
Parameters
- title: string
  Title of the dialog.
- message: string
  Message to show inside the dialog.
Returns BusyIndicator
The busy indicator instance.
Overrides IDialogs.showBusyIndicator
- Defined in dialogs/Dialogs.ts:52

showConfirmation

showConfirmation(
    title: string,
    message: string,
    buttons: DialogButtons,
): Promise<DialogResult>
Show a standard confirmation dialog.
Parameters
- title: string
  Title of the dialog.
- message: string
  Message to show inside the dialog.
- buttons: DialogButtons
  Buttons to have on the dialog
Returns Promise<DialogResult>
The result of the dialog.
Overrides IDialogs.showConfirmation
- Defined in dialogs/Dialogs.ts:46