dialog
显示用于打开和保存文件、警报等的本地系统对话框。
进程:主进程
显示用于选择多个文件的对话框示例
const { dialog } = require('electron')
console.log(dialog.showOpenDialog({ properties: ['openFile', 'multiSelections'] }))
方法
dialog
模块包含以下方法
dialog.showOpenDialogSync([window, ]options)
window
BaseWindow (可选)
返回 string[] | undefined
,用户选择的文件路径;如果对话框被取消,则返回 undefined
。
window
参数允许对话框附加到父窗口,使其成为模态对话框。
filters
指定了一个文件类型数组,当你希望将用户限制为特定类型时,可以显示或选择这些文件类型。例如
{
filters: [
{ name: 'Images', extensions: ['jpg', 'png', 'gif'] },
{ name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
{ name: 'Custom File Type', extensions: ['as'] },
{ name: 'All Files', extensions: ['*'] }
]
}
extensions
数组应包含不带通配符或点的扩展名(例如 'png'
是好的,但 '.png'
和 '*.png'
是不好的)。要显示所有文件,请使用 '*'
通配符(不支持其他通配符)。
在 Windows 和 Linux 上,打开对话框不能同时作为文件选择器和目录选择器,因此,如果您在这些平台上将 properties
设置为 ['openFile', 'openDirectory']
,将显示目录选择器。
dialog.showOpenDialogSync(mainWindow, {
properties: ['openFile', 'openDirectory']
})
在 Linux 上,当使用 portal 文件选择器对话框时,除非 portal 后端版本为 4 或更高,否则不支持 defaultPath
。您可以使用 --xdg-portal-required-version
命令行开关强制使用 gtk 或 kde 对话框。
dialog.showOpenDialog([window, ]options)
window
BaseWindow (可选)
返回 Promise<Object>
- 解析为包含以下内容的对象
canceled
boolean - 对话框是否被取消。filePaths
string[] - 用户选择的文件路径数组。如果对话框被取消,这将是一个空数组。bookmarks
string[] (可选) macOS MAS - 一个与filePaths
数组匹配的 base64 编码字符串数组,其中包含安全范围的书签数据。必须启用securityScopedBookmarks
才能填充此项。(有关返回值,请参见此处表格。)
window
参数允许对话框附加到父窗口,使其成为模态对话框。
filters
指定了一个文件类型数组,当你希望将用户限制为特定类型时,可以显示或选择这些文件类型。例如
{
filters: [
{ name: 'Images', extensions: ['jpg', 'png', 'gif'] },
{ name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
{ name: 'Custom File Type', extensions: ['as'] },
{ name: 'All Files', extensions: ['*'] }
]
}
extensions
数组应包含不带通配符或点的扩展名(例如 'png'
是好的,但 '.png'
和 '*.png'
是不好的)。要显示所有文件,请使用 '*'
通配符(不支持其他通配符)。
在 Windows 和 Linux 上,打开对话框不能同时作为文件选择器和目录选择器,因此,如果您在这些平台上将 properties
设置为 ['openFile', 'openDirectory']
,将显示目录选择器。
dialog.showOpenDialog(mainWindow, {
properties: ['openFile', 'openDirectory']
}).then(result => {
console.log(result.canceled)
console.log(result.filePaths)
}).catch(err => {
console.log(err)
})
在 Linux 上,当使用 portal 文件选择器对话框时,除非 portal 后端版本为 4 或更高,否则不支持 defaultPath
。您可以使用 --xdg-portal-required-version
命令行开关强制使用 gtk 或 kde 对话框。
dialog.showSaveDialogSync([window, ]options)
window
BaseWindow (可选)
返回 string
,用户选择的文件路径;如果对话框被取消,则返回空字符串。
window
参数允许对话框附加到父窗口,使其成为模态对话框。
filters
指定了一个可显示的文件类型数组,请参阅 dialog.showOpenDialog
了解示例。
dialog.showSaveDialog([window, ]options)
window
BaseWindow (可选)
返回 Promise<Object>
- 解析为包含以下内容的对象
canceled
boolean - 对话框是否被取消。filePath
string - 如果对话框被取消,这将是一个空字符串。bookmark
string (可选) macOS MAS - Base64 编码的字符串,包含保存文件的安全范围书签数据。必须启用securityScopedBookmarks
才能存在此项。(有关返回值,请参见此处表格。)
window
参数允许对话框附加到父窗口,使其成为模态对话框。
filters
指定了一个可显示的文件类型数组,请参阅 dialog.showOpenDialog
了解示例。
在 macOS 上,建议使用异步版本,以避免展开和折叠对话框时出现问题。
dialog.showMessageBoxSync([window, ]options)
window
BaseWindow (可选)
返回 Integer
- 单击按钮的索引。
显示一个消息框,它会阻塞进程直到消息框关闭。它返回被点击按钮的索引。
window
参数允许对话框附加到父窗口,使其成为模态对话框。如果 window
未显示,对话框将不会附加到它。在这种情况下,它将显示为一个独立的窗口。
dialog.showMessageBox([window, ]options)
window
BaseWindow (可选)
返回 Promise<Object>
- 解析为包含以下属性的 Promise
response
number - 点击按钮的索引。checkboxChecked
boolean - 如果设置了checkboxLabel
,则为复选框的选中状态。否则为false
。
显示一个消息框。
window
参数允许对话框附加到父窗口,使其成为模态对话框。
dialog.showErrorBox(title, content)
title
string - 在错误框中显示的标题。content
string - 在错误框中显示的文本内容。
显示一个模态对话框,其中包含错误消息。
此 API 可以在 app
模块发出 ready
事件之前安全调用,通常用于报告启动初期的错误。如果在 Linux 上应用程序 ready
事件之前调用,消息将被输出到 stderr,并且不会出现 GUI 对话框。
dialog.showCertificateTrustDialog([window, ]options)
macOS Windows
window
BaseWindow (可选)
返回 Promise<void>
- 在显示证书信任对话框时解析。
在 macOS 上,此方法会显示一个模态对话框,显示消息和证书信息,并允许用户选择信任/导入证书。如果提供 window
参数,对话框将附加到父窗口,使其成为模态对话框。
在 Windows 上,由于使用的 Win32 API,选项更有限
message
参数不使用,因为操作系统提供自己的确认对话框。window
参数被忽略,因为无法使此确认对话框成为模态。
书签数组
showOpenDialog
和 showSaveDialog
解析为一个带有 bookmarks
字段的对象。此字段是 Base64 编码字符串的数组,其中包含已保存文件的安全范围书签数据。必须启用 securityScopedBookmarks
选项才能存在此项。
构建类型 | securityScopedBookmarks boolean | 返回类型 | 返回值 |
---|---|---|---|
macOS mas | 真 | 成功 | ['LONGBOOKMARKSTRING'] |
macOS mas | 真 | 错误 | [''] (空字符串数组) |
macOS mas | 假 | 不适用 | [] (空数组) |
非 mas | 任意 | 不适用 | [] (空数组) |
表单
在 macOS 上,如果您在 window
参数中提供 BaseWindow
引用,对话框将作为附加到窗口的表单呈现;如果未提供窗口,则作为模态对话框呈现。
您可以调用 BaseWindow.getCurrentWindow().setSheetOffset(offset)
来更改表单附加到窗口框架的偏移量。