Class WorkbenchDialog<R>`Abstract`

Handle to interact with a dialog opened via WorkbenchDialogService.

The dialog microfrontend can inject this handle to interact with the dialog, such as setting the title, reading parameters, or closing it.

See

WorkbenchDialogCapability
WorkbenchDialogService

Type Parameters

R = unknown

Index

Constructors

Properties

capability focused$ id params

Methods

close setTitle signalReady

Constructors

constructor

new WorkbenchDialog<R = unknown>(): WorkbenchDialog<R>
Type Parameters
- R = unknown
Returns WorkbenchDialog<R>

Properties

`Abstract` `Readonly`capability

capability: WorkbenchDialogCapability

Capability of the microfrontend loaded into this dialog.

`Abstract` `Readonly`focused$

focused$: Observable<boolean>

Indicates whether this dialog has the focus.

`Abstract` `Readonly`id

id: `dialog.${string}`

Represents the identity of this dialog.

`Abstract` `Readonly`params

params: Map<string, unknown>

Parameters as passed by the dialog opener.

Methods

`Abstract`close

close(result?: Error | R): void
Closes the dialog. Optionally, pass a result or an error to the dialog opener.
Parameters
- Optionalresult: Error | R
Returns void
- Defined in dialog/workbench-dialog.ts:74

`Abstract`setTitle

setTitle(title: string): void
Sets the title of the dialog.

Can be text or a translation key. A translation key starts with the percent symbol (%) and may include parameters in matrix notation for text interpolation.
Parameters
- title: string
Returns void
- Defined in dialog/workbench-dialog.ts:48
setTitle(title: Observable<string>): void
Sets the title of the dialog.
Parameters
- title: Observable<string>
Returns void
Deprecated
since version 1.0.0-beta.31. To migrate, pass a translatable and provide the text using a text provider registered in WorkbenchClient.registerTextProvider.
- Defined in dialog/workbench-dialog.ts:55

`Abstract`signalReady

signalReady(): void
Signals readiness, notifying the workbench that this dialog has completed initialization.

If showSplash is set to true on the dialog capability, the workbench displays a splash until the dialog microfrontend signals readiness.

Returns void
See
WorkbenchDialogCapability.properties.showSplash
- Defined in dialog/workbench-dialog.ts:69