跳至主要内容

dialog

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

进程:主进程

显示一个对话框以选择多个文件的示例

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

方法

dialog 模块具有以下方法

dialog.showOpenDialogSync([browserWindow, ]options)

  • browserWindow BrowserWindow(可选)
  • 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

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

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([browserWindow, ]options)

  • browserWindow BrowserWindow(可选)
  • 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 才能填充此数据。(有关返回值,请参见此处表格。)

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

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([browserWindow, ]options)

  • browserWindow BrowserWindow(可选)
  • 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 | undefined,即用户选择的文件路径;如果取消对话框,则返回 undefined

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

filters 指定可以显示的文件类型数组,请参阅 dialog.showOpenDialog 以获取示例。

dialog.showSaveDialog([browserWindow, ]options)

  • browserWindow BrowserWindow(可选)
  • 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 字符串(可选) - 如果取消对话框,这将是 undefined
  • bookmark 字符串(可选)macOS MAS - 包含已保存文件安全范围书签数据的 Base64 编码字符串。必须启用 securityScopedBookmarks 才能显示此项。(有关返回值,请参阅 此处表格。)

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

filters 指定可以显示的文件类型数组,请参阅 dialog.showOpenDialog 以获取示例。

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

dialog.showMessageBoxSync([browserWindow, ]options)

  • browserWindow BrowserWindow(可选)
  • options 对象
    • message 字符串 - 消息框的内容。
    • type 字符串(可选) - 可以是 noneinfoerrorquestionwarning。在 Windows 上,question 显示与 info 相同的图标,除非您使用 icon 选项设置图标。在 macOS 上,warningerror 都显示相同的警告图标。
    • buttons 字符串数组(可选) - 按钮文本数组。在 Windows 上,空数组将产生一个标有“确定”的按钮。
    • defaultId 整数(可选) - 消息框打开时将在按钮数组中选中的按钮索引。
    • 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 - 单击按钮的索引。

显示一个消息框,它将阻塞进程,直到消息框关闭。它返回单击按钮的索引。

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

dialog.showMessageBox([browserWindow, ]options)

  • browserWindow BrowserWindow(可选)
  • options 对象
    • message 字符串 - 消息框的内容。
    • type 字符串(可选) - 可以是 noneinfoerrorquestionwarning。在 Windows 上,question 显示与 info 相同的图标,除非您使用 icon 选项设置图标。在 macOS 上,warningerror 都显示相同的警告图标。
    • buttons 字符串数组(可选) - 按钮文本数组。在 Windows 上,空数组将产生一个标有“确定”的按钮。
    • defaultId 整数(可选) - 消息框打开时将在按钮数组中选中的按钮索引。
    • signal AbortSignal(可选) - 传递 AbortSignal 的一个实例以选择性地关闭消息框,消息框的行为将如同用户取消了一样。在 macOS 上,signal 不适用于没有父窗口的消息框,因为这些消息框由于平台限制而同步运行。
    • title 字符串(可选) - 消息框的标题,某些平台不会显示它。
    • detail 字符串(可选) - 消息的附加信息。
    • checkboxLabel 字符串(可选) - 如果提供,消息框将包含一个具有给定标签的复选框。
    • checkboxChecked 布尔值(可选) - 复选框的初始选中状态。默认为 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 数字 - 单击按钮的索引。
  • checkboxChecked 布尔值 - 如果设置了 checkboxLabel,则为复选框的选中状态。否则为 false

显示一个消息框。

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

dialog.showErrorBox(title, content)

  • title 字符串 - 在错误框中显示的标题。
  • content 字符串 - 在错误框中显示的文本内容。

显示一个模态对话框,显示一条错误消息。

app 模块发出 ready 事件之前,可以安全地调用此 API,通常用于报告启动早期阶段的错误。如果在 Linux 上的应用程序 ready 事件之前调用,则会将消息发送到 stderr,并且不会出现 GUI 对话框。

dialog.showCertificateTrustDialog([browserWindow, ]options) macOS Windows

  • browserWindow BrowserWindow(可选)
  • options 对象
    • certificate Certificate - 要信任/导入的证书。
    • message 字符串 - 向用户显示的消息。

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

在 macOS 上,这会显示一个模态对话框,其中显示一条消息和证书信息,并为用户提供信任/导入证书的选项。如果您提供 browserWindow 参数,则该对话框将附加到父窗口,使其成为模态。

在 Windows 上,由于使用了 Win32 API,因此选项受到更多限制

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

书签数组

showOpenDialogshowOpenDialogSyncshowSaveDialogshowSaveDialogSync 将返回一个 bookmarks 数组。

构建类型securityScopedBookmarks 布尔值返回类型返回值
macOS masTrue成功['LONGBOOKMARKSTRING']
macOS masTrue错误[''](空字符串数组)
macOS masFalse不适用[](空数组)
非 mas任何不适用[](空数组)

工作表

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

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