@serenity-is/corelib / informationDialog

Function: informationDialog()

informationDialog(message, onOk?, options?): Partial<Dialog>

Defined in: src/base/dialogs.tsx:1163

Displays an informational dialog with a single OK button.

Parameters

message

RenderableContent

Text or renderable content shown in the dialog body.

onOk?

() => void

Optional callback invoked when OK is clicked.

options?

MessageDialogOptions

Additional MessageDialogOptions.

Returns

Partial<Dialog>

A Dialog handle (partial when falling back to the native alert()).

Example

informationDialog("Operation complete", () => {
  // do something when OK is clicked
});