跳至主要内容

dialog

显示用于打开和保存文件、警告等的原生系统对话框。

进程:主进程

显示用于选择多个文件的对话框的示例

const { dialog } = require('electron')
console.log(dialog.showOpenDialog({ properties: ['openFile', 'multiSelections'] }))

方法

dialog 模块具有以下方法

dialog.showOpenDialogSync([window, ]options)

  • window BaseWindow(可选)
  • options 对象
    • title 字符串(可选)
    • defaultPath 字符串(可选)
    • buttonLabel 字符串(可选) - 确认按钮的自定义标签,为空时将使用默认标签。
    • filters FileFilter[](可选)
    • properties 字符串数组(可选) - 包含对话框应使用的功能。支持以下值:
      • openFile - 允许选择文件。
      • openDirectory - 允许选择目录。
      • multiSelections - 允许选择多个路径。
      • showHiddenFiles - 在对话框中显示隐藏文件。
      • createDirectory macOS - 允许从对话框创建新目录。
      • promptToCreate Windows - 如果对话框中输入的文件路径不存在,则提示创建。这实际上不会在路径中创建文件,但允许返回应由应用程序创建的非现有路径。
      • noResolveAliases macOS - 禁用自动别名(符号链接)路径解析。现在,选定的别名将返回别名路径而不是其目标路径。
      • treatPackageAsDirectory macOS - 将包(例如 .app 文件夹)视为目录而不是文件。
      • dontAddToRecent Windows - 不要将正在打开的项目添加到最近的文档列表中。
    • message 字符串(可选) macOS - 在输入框上方显示的消息。
    • securityScopedBookmarks 布尔值(可选) macOS MAS - 为 Mac App Store 打包时创建安全作用域书签

返回 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(可选)
  • options 对象
    • title 字符串(可选)
    • defaultPath 字符串(可选)
    • buttonLabel 字符串(可选) - 确认按钮的自定义标签,为空时将使用默认标签。
    • filters FileFilter[](可选)
    • properties 字符串数组(可选) - 包含对话框应使用的功能。支持以下值:
      • openFile - 允许选择文件。
      • openDirectory - 允许选择目录。
      • multiSelections - 允许选择多个路径。
      • showHiddenFiles - 在对话框中显示隐藏文件。
      • createDirectory macOS - 允许从对话框创建新目录。
      • promptToCreate Windows - 如果对话框中输入的文件路径不存在,则提示创建。这实际上不会在路径中创建文件,但允许返回应由应用程序创建的非现有路径。
      • noResolveAliases macOS - 禁用自动别名(符号链接)路径解析。现在,选定的别名将返回别名路径而不是其目标路径。
      • treatPackageAsDirectory macOS - 将包(例如 .app 文件夹)视为目录而不是文件。
      • dontAddToRecent Windows - 不要将正在打开的项目添加到最近的文档列表中。
    • message 字符串(可选) macOS - 在输入框上方显示的消息。
    • securityScopedBookmarks 布尔值(可选) macOS MAS - 为 Mac App Store 打包时创建安全作用域书签

返回 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(可选)
  • options 对象
    • title 字符串(可选) - 对话框标题。在某些Linux 桌面环境中无法显示。
    • defaultPath 字符串(可选) - 默认使用的绝对目录路径、绝对文件路径或文件名。
    • buttonLabel 字符串(可选) - 确认按钮的自定义标签,为空时将使用默认标签。
    • filters FileFilter[](可选)
    • message 字符串(可选) macOS - 在文本字段上方显示的消息。
    • nameFieldLabel 字符串(可选) macOS - 文件名文本字段前面显示的文本的自定义标签。
    • showsTagField 布尔值(可选) macOS - 显示标签输入框,默认为 true
    • properties 字符串数组(可选)
      • showHiddenFiles - 在对话框中显示隐藏文件。
      • createDirectory macOS - 允许从对话框创建新目录。
      • treatPackageAsDirectory macOS - 将包(例如 .app 文件夹)视为目录而不是文件。
      • showOverwriteConfirmation Linux - 设置如果用户键入已存在的文件名,是否会向用户显示确认对话框。
      • dontAddToRecent Windows - 不要将正在保存的项目添加到最近的文档列表中。
    • securityScopedBookmarks 布尔值(可选) macOS MAS - 为 Mac App Store 打包时创建安全作用域书签。如果启用此选项并且文件尚不存在,则将在所选路径中创建一个空白文件。

返回 string,用户选择的文件的路径;如果对话框被取消,则返回空字符串。

window 参数允许对话框附加到父窗口,使其成为模态对话框。

filters 指定文件类型的数组,请参阅 dialog.showOpenDialog 以了解示例。

dialog.showSaveDialog([window, ]options)

  • window BaseWindow(可选)
  • options 对象
    • title 字符串(可选) - 对话框标题。在某些Linux 桌面环境中无法显示。
    • defaultPath 字符串(可选) - 默认使用的绝对目录路径、绝对文件路径或文件名。
    • buttonLabel 字符串(可选) - 确认按钮的自定义标签,为空时将使用默认标签。
    • filters FileFilter[](可选)
    • message 字符串(可选) macOS - 在文本字段上方显示的消息。
    • nameFieldLabel 字符串(可选) macOS - 文件名文本字段前面显示的文本的自定义标签。
    • showsTagField 布尔值(可选) macOS - 显示标签输入框,默认为 true
    • properties 字符串数组(可选)
      • showHiddenFiles - 在对话框中显示隐藏文件。
      • createDirectory macOS - 允许从对话框创建新目录。
      • treatPackageAsDirectory macOS - 将包(例如 .app 文件夹)视为目录而不是文件。
      • showOverwriteConfirmation Linux - 设置如果用户键入已存在的文件名,是否会向用户显示确认对话框。
      • dontAddToRecent Windows - 不要将正在保存的项目添加到最近的文档列表中。
    • securityScopedBookmarks 布尔值(可选) macOS MAS - 为 Mac App Store 打包时创建安全作用域书签。如果启用此选项并且文件尚不存在,则将在所选路径中创建一个空白文件。

返回 Promise<Object> - 解析包含以下内容的对象:

  • canceled 布尔值 - 对话框是否被取消。
  • filePath 字符串 - 如果对话框被取消,则此字符串将为空。
  • bookmark 字符串(可选) macOS MAS - 包含已保存文件的安全作用域书签数据的 base64 编码字符串。必须启用 securityScopedBookmarks 才能显示此字符串。(有关返回值,请参阅此处的表格。)

window 参数允许对话框附加到父窗口,使其成为模态对话框。

filters 指定文件类型的数组,请参阅 dialog.showOpenDialog 以了解示例。

注意:在 macOS 上,建议使用异步版本以避免在展开和折叠对话框时出现问题。

dialog.showMessageBoxSync([wndow, ]options)

  • window BaseWindow(可选)
  • options 对象
    • message 字符串 - 消息框的内容。
    • type 字符串(可选) - 可以是 noneinfoerrorquestionwarning。在 Windows 上,question 显示与 info 相同的图标,除非您使用 icon 选项设置了图标。在 macOS 上,warningerror 都显示相同的警告图标。
    • buttons 字符串数组(可选) - 按钮文本数组。在 Windows 上,空数组将导致一个标记为“确定”的按钮。
    • defaultId 整数(可选) - 消息框打开时默认选中的按钮在 buttons 数组中的索引。
    • title 字符串(可选) - 消息框的标题,某些平台不会显示它。
    • detail 字符串(可选) - 消息的额外信息。
    • icon (NativeImage | 字符串)(可选)
    • textWidth 整数(可选) macOS - 消息框中文本的自定义宽度。
    • cancelId 整数(可选) - 用于通过 Esc 键取消对话框的按钮的索引。默认情况下,此值分配给标签为“取消”或“否”的第一个按钮。如果没有这样的标签按钮并且未设置此选项,则 0 将用作返回值。
    • noLink 布尔值(可选) - 在 Windows 上,Electron 将尝试确定 buttons 中哪些是常用按钮(如“取消”或“是”),并在对话框中将其他按钮显示为命令链接。这可以使对话框以现代 Windows 应用程序的样式显示。如果您不喜欢这种行为,可以将 noLink 设置为 true
    • normalizeAccessKeys 布尔值(可选) - 在平台之间规范化键盘访问键。默认为 false。启用此选项表示在按钮标签中使用 & 来放置键盘快捷键访问键,并且标签将被转换以使其在每个平台上都能正常工作,& 字符在 macOS 上被删除,在 Linux 上被转换为 _,在 Windows 上保持不变。例如,按钮标签 Vie&w 将在 Linux 上转换为 Vie_w,在 macOS 上转换为 View,并且可以通过 Windows 和 Linux 上的 Alt-W 进行选择。

返回 Integer - 被点击按钮的索引。

显示消息框,它将阻止进程,直到消息框关闭。它返回被点击按钮的索引。

window 参数允许对话框附加到父窗口,使其成为模态对话框。如果未显示 window,则对话框不会附加到它。在这种情况下,它将显示为独立窗口。

dialog.showMessageBox([window, ]options)

  • window BaseWindow(可选)
  • options 对象
    • message 字符串 - 消息框的内容。
    • type 字符串(可选) - 可以是 noneinfoerrorquestionwarning。在 Windows 上,question 显示与 info 相同的图标,除非您使用 icon 选项设置了图标。在 macOS 上,warningerror 都显示相同的警告图标。
    • buttons 字符串数组(可选) - 按钮文本数组。在 Windows 上,空数组将导致一个标记为“确定”的按钮。
    • defaultId 整数(可选) - 消息框打开时默认选中的按钮在 buttons 数组中的索引。
    • signal AbortSignal(可选) - 传递 AbortSignal 的实例以可选地关闭消息框,消息框的行为就像用户取消了一样。在 macOS 上,signal 不适用于没有父窗口的消息框,因为由于平台限制,这些消息框是同步运行的。
    • title 字符串(可选) - 消息框的标题,某些平台不会显示它。
    • detail 字符串(可选) - 消息的额外信息。
    • checkboxLabel string(可选) - 如果提供,消息框将包含一个带有给定标签的复选框。
    • checkboxChecked boolean(可选) - 复选框的初始选中状态。默认为 false
    • icon (NativeImage | 字符串)(可选)
    • textWidth 整数(可选) macOS - 消息框中文本的自定义宽度。
    • cancelId 整数(可选) - 用于通过 Esc 键取消对话框的按钮的索引。默认情况下,此值分配给标签为“取消”或“否”的第一个按钮。如果没有这样的标签按钮并且未设置此选项,则 0 将用作返回值。
    • noLink 布尔值(可选) - 在 Windows 上,Electron 将尝试确定 buttons 中哪些是常用按钮(如“取消”或“是”),并在对话框中将其他按钮显示为命令链接。这可以使对话框以现代 Windows 应用程序的样式显示。如果您不喜欢这种行为,可以将 noLink 设置为 true
    • normalizeAccessKeys 布尔值(可选) - 在平台之间规范化键盘访问键。默认为 false。启用此选项表示在按钮标签中使用 & 来放置键盘快捷键访问键,并且标签将被转换以使其在每个平台上都能正常工作,& 字符在 macOS 上被删除,在 Linux 上被转换为 _,在 Windows 上保持不变。例如,按钮标签 Vie&w 将在 Linux 上转换为 Vie_w,在 macOS 上转换为 View,并且可以通过 Windows 和 Linux 上的 Alt-W 进行选择。

返回 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(可选)
  • options 对象
    • certificate Certificate - 要信任/导入的证书。
    • message string - 要显示给用户的消息。

返回 Promise<void> - 显示证书信任对话框时解析。

在 macOS 上,这将显示一个模态对话框,显示消息和证书信息,并允许用户选择是否信任/导入证书。如果提供 window 参数,则对话框将附加到父窗口,使其成为模态对话框。

在 Windows 上,由于使用了 Win32 API,因此选项更有限。

  • message 参数未使用,因为操作系统提供了自己的确认对话框。
  • window 参数被忽略,因为无法使此确认对话框成为模态对话框。

书签数组

showOpenDialogshowOpenDialogSyncshowSaveDialogshowSaveDialogSync 将返回一个 bookmarks 数组。

构建类型securityScopedBookmarks 布尔值返回类型返回值
macOS masTrue成功['LONGBOOKMARKSTRING']
macOS masTrue错误[''](空字符串数组)
macOS masFalseNA[](空数组)
非 mas任意NA[](空数组)

工作表

在 macOS 上,如果在 window 参数中提供 BaseWindow 引用,则对话框将显示为附加到窗口的工作表;如果没有提供窗口,则显示为模态对话框。

您可以调用 BaseWindow.getCurrentWindow().setSheetOffset(offset) 来更改工作表附加到窗口框架的偏移量。