Interface DialogApiDialog<TResult>

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

Remarks

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

interface DialogApiDialog<TResult = void> {
    close(
        ...args: undefined extends TResult
            ? [result?: TResult]
            : [result: TResult],
    ): void;
    result(): Promise<TResult>;
    update(
        elementOrComponent:
            | Element
            | ((props: { dialog: DialogApiDialog<TResult> }) => Element),
    ): void;
}

Type Parameters

TResult = void

Index

Methods

close result update

Methods

close

close(
    ...args: undefined extends TResult
        ? [result?: TResult]
        : [result: TResult],
): void
Closes the dialog with that provided result.
Parameters
- ...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.
- Defined in packages/frontend-plugin-api/src/apis/definitions/DialogApi.ts:36

result

result(): Promise<TResult>
Wait until the dialog is closed and return the result.

Returns Promise<TResult>
Remarks
If the dialog is a modal dialog a result will always be returned. If it's a regular dialog then the result may be undefined.
- Defined in packages/frontend-plugin-api/src/apis/definitions/DialogApi.ts:56

update

update(
    elementOrComponent:
        | Element
        | ((props: { dialog: DialogApiDialog<TResult> }) => Element),
): void
Replaces the content of the dialog with the provided element or component, causing it to be rerenedered.
Parameters
- elementOrComponent: Element | ((props: { dialog: DialogApiDialog<TResult> }) => Element)
Returns void
- Defined in packages/frontend-plugin-api/src/apis/definitions/DialogApi.ts:43

Interface DialogApiDialog<TResult>

Remarks

Type Parameters

Index

Methods

Methods

close

Parameters

Returns void

Remarks

result

Returns Promise<TResult>

Remarks

update

Parameters

Returns void

Settings

On This Page