Skip to main content
Version: Next

DialogApiDialog.close()

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

Closes the dialog with that provided result.

Signature:

close(...args: undefined extends TResult ? [result?: TResult] : [result: TResult]): void;

Parameters

Parameter

Type

Description

args

undefined extends TResult ? [result?: TResult] : [result: TResult]

**Returns:**

void

Remarks

If the dialog is a modal dialog a result must always be provided. If it's a regular dialog then passing a result is optional.