Skip to content

@serenity-is/corelib / success

Variable: success()

const success: (message, onOk?, options?) => Partial<Dialog> = successDialog

Defined in: src/compat/dialogs-compat.ts:29

Legacy success alias.

Displays a success 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

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

Deprecated

Use successDialog instead.

See

successDialog