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']
})
dialog.showOpenDialog([window, ]options)
window
BaseWindow(可选)
返回 Promise<Object>
- 解析包含以下内容的对象:
canceled
布尔值 - 对话框是否被取消。filePaths
字符串数组 - 用户选择的路径数组。如果对话框被取消,则此数组将为空。bookmarks
字符串数组(可选) 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)
})
dialog.showSaveDialogSync([window, ]options)
window
BaseWindow(可选)
返回 string
,用户选择的文件的路径;如果对话框被取消,则返回空字符串。
window
参数允许对话框附加到父窗口,使其成为模态对话框。
filters
指定文件类型的数组,请参阅 dialog.showOpenDialog
以了解示例。
dialog.showSaveDialog([window, ]options)
window
BaseWindow(可选)
返回 Promise<Object>
- 解析包含以下内容的对象:
canceled
布尔值 - 对话框是否被取消。filePath
字符串 - 如果对话框被取消,则此字符串将为空。bookmark
字符串(可选) macOS MAS - 包含已保存文件的安全作用域书签数据的 base64 编码字符串。必须启用securityScopedBookmarks
才能显示此字符串。(有关返回值,请参阅此处的表格。)
window
参数允许对话框附加到父窗口,使其成为模态对话框。
filters
指定文件类型的数组,请参阅 dialog.showOpenDialog
以了解示例。
注意:在 macOS 上,建议使用异步版本以避免在展开和折叠对话框时出现问题。
dialog.showMessageBoxSync([wndow, ]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 - 在错误框中显示的文本内容。
显示一个显示错误消息的模态对话框。
可以在 app
模块发出 ready
事件之前安全地调用此 API,它通常用于在启动的早期阶段报告错误。如果在 Linux 上的 app ready
事件之前调用,则消息将输出到 stderr,并且不会出现 GUI 对话框。
dialog.showCertificateTrustDialog([window, ]options)
macOS Windows
window
BaseWindow(可选)
返回 Promise<void>
- 显示证书信任对话框时解析。
在 macOS 上,这将显示一个模态对话框,显示消息和证书信息,并允许用户选择是否信任/导入证书。如果提供 window
参数,则对话框将附加到父窗口,使其成为模态对话框。
在 Windows 上,由于使用了 Win32 API,因此选项更有限。
message
参数未使用,因为操作系统提供了自己的确认对话框。window
参数被忽略,因为无法使此确认对话框成为模态对话框。
书签数组
showOpenDialog
、showOpenDialogSync
、showSaveDialog
和 showSaveDialogSync
将返回一个 bookmarks
数组。
构建类型 | securityScopedBookmarks 布尔值 | 返回类型 | 返回值 |
---|---|---|---|
macOS mas | True | 成功 | ['LONGBOOKMARKSTRING'] |
macOS mas | True | 错误 | [''] (空字符串数组) |
macOS mas | False | NA | [] (空数组) |
非 mas | 任意 | NA | [] (空数组) |
工作表
在 macOS 上,如果在 window
参数中提供 BaseWindow
引用,则对话框将显示为附加到窗口的工作表;如果没有提供窗口,则显示为模态对话框。
您可以调用 BaseWindow.getCurrentWindow().setSheetOffset(offset)
来更改工作表附加到窗口框架的偏移量。