addOnUISdk.instance.runtime.dialog

Represents the modal dialog presented to the user. This object can be used to manage the dialog, like closing it and sending results to the caller. Check out the modal dialogs use case examples for more details on using dialogs, as well as the related showModalDialog method.

data-slots=text

data-variant=info

Runtime: This API runs in the iframe runtime (addOnUISdk.instance.runtime.dialog). See the Add-on Architecture Guide for the dual-runtime model.

Methods

close()

close(result?: unknown): void<br/> Closes the modal dialog and posts the result back to the dialog invoker.

Parameters

Name

Type

Description

result?

unknown

An optional result to return to the dialog invoker.

Returns

void. The result is delivered to the caller of showModalDialog(), not returned here.

Example Usage

import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Wait for the SDK to be ready
await addOnUISdk.ready;

closeButton.onsubmit = () => {
  // User cancelled the operation, close the dialog with no result
  addOnUISdk.instance.runtime.dialog.close();
};

createButton.onsubmit = () => {
  // user has selected a design - close the dialog & report the selection details as the result back to the caller.
  addOnUISdk.instance.runtime.dialog.close({
    selectedDesign: "grid-layout",
  });
};