@zturnlibs/ztron-api

---

dialog#

Interfaces#

MessageDialogOptions#

Defined in: dialog.ts:26

Extended by#

• MessageDialogOptionsFull

Properties#

kind?#

optional kind?: "info" | "warning" | "error"

Defined in: dialog.ts:29

Alert severity: "info" (default) | "warning" | "error".

title?#

optional title?: string

Defined in: dialog.ts:27

---

MessageDialogOptionsFull#

Defined in: dialog.ts:32

Extends#

• MessageDialogOptions

Properties#

kind?#

optional kind?: "info" | "warning" | "error"

Defined in: dialog.ts:29

Alert severity: "info" (default) | "warning" | "error".

Inherited from#

MessageDialogOptions.kind

message?#

optional message?: string

Defined in: dialog.ts:33

title?#

optional title?: string

Defined in: dialog.ts:27

Inherited from#

MessageDialogOptions.title

---

OpenDialogOptions#

Defined in: dialog.ts:10

Properties#

canCreateDirectories?#

optional canCreateDirectories?: boolean

Defined in: dialog.ts:18

directory?#

optional directory?: boolean

Defined in: dialog.ts:12

filters?#

optional filters?: string[]

Defined in: dialog.ts:15

Allowed extensions, e.g. ["png","jpg"].

maxFiles?#

optional maxFiles?: number

Defined in: dialog.ts:17

Max selectable files (>1 enables multi-select; result becomes an array).

multiple?#

optional multiple?: boolean

Defined in: dialog.ts:13

title?#

optional title?: string

Defined in: dialog.ts:11

---

SaveDialogOptions#

Defined in: dialog.ts:21

Properties#

defaultName?#

optional defaultName?: string

Defined in: dialog.ts:23

title?#

optional title?: string

Defined in: dialog.ts:22

Variables#

dialog#

const dialog: object

Defined in: dialog.ts:106

Type Declaration#

ask#

ask: (messageOrOptions, options) => Promise<boolean>

Shows an OK/Cancel question dialog; resolves true when confirmed.

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

confirm#

confirm: (messageOrOptions, options) => Promise<boolean>

Shows an OK/Cancel confirmation; resolves true when confirmed.

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

message#

message: (messageOrOptions, options) => Promise<number>

Shows a native message/alert dialog; returns the clicked button index.

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<number>

open#

open: (options) => Promise<string | string[] | null>

Shows a native open-file (or directory) dialog; null if cancelled.

Parameters#

options?#

OpenDialogOptions = {}

Returns#

Promise<string | string[] | null>

save#

save: (options) => Promise<string | null>

Shows a native save dialog; null if cancelled.

Parameters#

options?#

SaveDialogOptions = {}

Returns#

Promise<string | null>

Functions#

ask()#

ask(messageOrOptions, options?): Promise<boolean>

Defined in: dialog.ts:75

Shows an OK/Cancel question dialog; resolves true when confirmed.

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

---

confirm()#

confirm(messageOrOptions, options?): Promise<boolean>

Defined in: dialog.ts:91

Shows an OK/Cancel confirmation; resolves true when confirmed.

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

---

message()#

message(messageOrOptions, options?): Promise<number>

Defined in: dialog.ts:59

Shows a native message/alert dialog; returns the clicked button index.

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<number>

---

open()#

open(options?): Promise<string | string[] | null>

Defined in: dialog.ts:37

Shows a native open-file (or directory) dialog; null if cancelled.

Parameters#

options?#

OpenDialogOptions = {}

Returns#

Promise<string | string[] | null>

---

save()#

save(options?): Promise<string | null>

Defined in: dialog.ts:52

Shows a native save dialog; null if cancelled.

Parameters#

options?#

SaveDialogOptions = {}

Returns#

Promise<string | null>