Skip to content

@jsvision/ui / confirm

Function: confirm() ​

confirm(host, text): Promise<boolean>

Defined in: ui/src/dialog/message-box.ts:253

Ask a yes/no question modally.

Parameters ​

host ​

ModalDialogHost

The modal host (an Application, or { loop, desktop, i18n }).

text ​

string

The question; the box sizes itself to fit.

Returns ​

Promise<boolean>

true on Yes; false on No, Esc, or closing the box.

Example ​

ts
import { createApplication, confirm } from '@jsvision/ui';
import { resolveCapabilities } from '@jsvision/core';

const caps = resolveCapabilities().profile;
const app = createApplication({ caps });

function discard(): void {
  // Drop the unsaved edits.
}

if (await confirm(app, 'Discard unsaved changes?')) discard();