@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

提示严重度："info"（默认）| "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

提示严重度："info"（默认）| "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

允许的扩展名，如 ["png","jpg"]。

maxFiles?#

optional maxFiles?: number

Defined in: dialog.ts:17

最大可选文件数（>1 启用多选；结果变为数组）。

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>

弹出 OK/Cancel 询问对话框；确认时 resolve true。

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

confirm#

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

弹出 OK/Cancel 确认对话框；确认时 resolve true。

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

message#

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

弹出原生消息/警告对话框；返回被点击按钮的索引。

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<number>

open#

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

弹出原生打开文件（或目录）对话框；取消时为 null。

Parameters#

options?#

OpenDialogOptions = {}

Returns#

Promise<string | string[] | null>

save#

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

弹出原生保存对话框；取消时为 null。

Parameters#

options?#

SaveDialogOptions = {}

Returns#

Promise<string | null>

Functions#

ask()#

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

Defined in: dialog.ts:75

弹出 OK/Cancel 询问对话框；确认时 resolve true。

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

---

confirm()#

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

Defined in: dialog.ts:91

弹出 OK/Cancel 确认对话框；确认时 resolve true。

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<boolean>

---

message()#

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

Defined in: dialog.ts:59

弹出原生消息/警告对话框；返回被点击按钮的索引。

Parameters#

messageOrOptions#

string | MessageDialogOptionsFull & object

options?#

MessageDialogOptions = {}

Returns#

Promise<number>

---

open()#

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

Defined in: dialog.ts:37

弹出原生打开文件（或目录）对话框；取消时为 null。

Parameters#

options?#

OpenDialogOptions = {}

Returns#

Promise<string | string[] | null>

---

save()#

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

Defined in: dialog.ts:52

弹出原生保存对话框；取消时为 null。

Parameters#

options?#

SaveDialogOptions = {}

Returns#

Promise<string | null>