DialogApiDialog

Home > @backstage/frontend-plugin-api > DialogApiDialog

A handle for an open dialog that can be used to interact with it.

Signature:

export interface DialogApiDialog<TResult = unknown> 

Remarks

Dialogs can be opened using either DialogApi.show() or DialogApi.showModal().

Methods

Method	Description
close(args)	Closes the dialog with that provided result.
result()	Wait until the dialog is closed and return the result.
update(elementOrComponent)	Replaces the content of the dialog with the provided element or component, causing it to be rerenedered.