Skip to content

@jsvision/ui / findDialog

Function: findDialog()

findDialog(host, initial?): Promise<FindRec | null>

Defined in: ui/src/editor/dialogs.ts:72

Open the Find dialog — a text field with "Case sensitive" and "Whole words only" checkboxes.

Parameters

host

ModalDialogHost

The modal host, including its translation service.

initial?

FindRec

Optional values to pre-fill the field and checkboxes.

Returns

Promise<FindRec | null>

The entered search record, or null if the user cancels.

Example

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

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

const rec = await findDialog(app, {
  find: 'fox',
  options: { caseSensitive: false, wholeWords: false },
});
if (rec !== null) console.log('search for', rec.find);