Class CommonDialogService

Service for showing common application dialogs — alert, confirm, prompt, open-file, save-file, and about.

Each method opens a modal dialog and returns a Promise that resolves when the user closes it. The service delegates to ModalService for the underlying dialog lifecycle.

Example

const confirmed = await this.dialogs.confirm({
  title: 'Delete item?',
  message: 'This action cannot be undone.',
  variant: 'danger',
});

if (confirmed) { ... }

Index

Constructors

constructor

Methods

about alert confirm openFile prompt saveFile

Constructors

constructor

new CommonDialogService(): CommonDialogService
Returns CommonDialogService

Methods

about

about(options: AboutOptions): Promise<void>
Show an "About" dialog with application information.
Parameters
- options: AboutOptions
Returns Promise<void>
Resolves when the user closes the dialog.
- Defined in packages/ui-blocks/src/lib/common-dialogs/common-dialog.service.ts:163

alert

alert(options: AlertOptions): Promise<void>
Show a simple informational alert with a dismiss button.
Parameters
- options: AlertOptions
Returns Promise<void>
Resolves when the user dismisses the dialog.
- Defined in packages/ui-blocks/src/lib/common-dialogs/common-dialog.service.ts:52

confirm

confirm(options: ConfirmOptions): Promise<boolean>
Show a confirmation dialog with confirm and cancel buttons.
Parameters
- options: ConfirmOptions
Returns Promise<boolean>
true if the user confirmed, false otherwise.
- Defined in packages/ui-blocks/src/lib/common-dialogs/common-dialog.service.ts:70

openFile

openFile<M = unknown>(
options: OpenFileOptions<M>,
): Promise<OpenFileResult<M> | null>
Show an open-file dialog powered by UIFileBrowser.
Type Parameters
- M = unknown
Parameters
- options: OpenFileOptions<M>
Returns Promise<OpenFileResult<M> | null>
The selected file(s), or null if cancelled.
- Defined in packages/ui-blocks/src/lib/common-dialogs/common-dialog.service.ts:113

prompt

prompt(options: PromptOptions): Promise<string | null>
Show a prompt dialog with a text input.
Parameters
- options: PromptOptions
Returns Promise<string | null>
The entered string, or null if cancelled.
- Defined in packages/ui-blocks/src/lib/common-dialogs/common-dialog.service.ts:91

saveFile

saveFile<M = unknown>(
options: SaveFileOptions<M>,
): Promise<SaveFileResult<M> | null>
Show a save-file dialog powered by UIFileBrowser with a file-name input.
Type Parameters
- M = unknown
Parameters
- options: SaveFileOptions<M>
Returns Promise<SaveFileResult<M> | null>
The directory and file name, or null if cancelled.
- Defined in packages/ui-blocks/src/lib/common-dialogs/common-dialog.service.ts:138

Class CommonDialogService

Example

Index

Constructors

Methods

Constructors

constructor

Returns CommonDialogService

Methods

about

Parameters

Returns Promise<void>

alert

Parameters

Returns Promise<void>

confirm

Parameters

Returns Promise<boolean>

openFile

Type Parameters

Parameters

Returns Promise<OpenFileResult<M> | null>

prompt

Parameters

Returns Promise<string | null>

saveFile

Type Parameters

Parameters

Returns Promise<SaveFileResult<M> | null>

Settings

On This Page