跳至主要内容

shell

使用其默认应用程序管理文件和 URL。

进程:主进程渲染进程(仅限非沙盒)

shell 模块提供与桌面集成相关的函数。

在用户默认浏览器中打开 URL 的示例

const { shell } = require('electron')

shell.openExternal('https://github.com')

注意:虽然可以在渲染进程中使用 shell 模块,但它在沙盒渲染器中将无法工作。

方法

shell 模块具有以下方法

shell.showItemInFolder(fullPath)

  • fullPath 字符串

在文件管理器中显示给定的文件。如果可能,选择该文件。

shell.openPath(path)

  • path 字符串

返回 Promise<string> - 如果发生错误,则解析包含对应错误消息的字符串,否则返回 ""。

以桌面的默认方式打开给定的文件。

shell.openExternal(url[, options])

  • url 字符串 - Windows 上最多 2081 个字符。
  • options 对象(可选)
    • activate 布尔值(可选) macOS - true 将打开的应用程序置于前台。默认为 true
    • workingDirectory 字符串(可选) Windows - 工作目录。
    • logUsage 布尔值(可选) Windows - 指示用户发起的启动,该启动启用对常用程序和其他行为的跟踪。默认为 false

返回 Promise<void>

以桌面的默认方式打开给定的外部协议 URL。(例如,用户默认邮件代理中的 mailto: URL)。

shell.trashItem(path)

  • path 字符串 - 要移动到废纸篓的项目的路径。

返回 Promise<void> - 操作完成后解析。如果在删除请求的项目时发生错误,则拒绝。

这会将路径移动到操作系统特定的废纸篓位置(macOS 上的废纸篓、Windows 上的回收站以及 Linux 上的桌面环境特定位置)。

shell.beep()

播放蜂鸣声。

shell.writeShortcutLink(shortcutPath[, operation], options) Windows

  • shortcutPath 字符串
  • operation 字符串(可选) - 默认为 create,可以是以下之一
    • create - 创建新的快捷方式,如有必要则覆盖。
    • update - 仅更新现有快捷方式上的指定属性。
    • replace - 覆盖现有快捷方式,如果快捷方式不存在则失败。
  • options ShortcutDetails

返回 boolean - 快捷方式是否创建成功。

创建或更新 shortcutPath 处的快捷方式链接。

shell.readShortcutLink(shortcutPath) Windows

  • shortcutPath 字符串

返回 ShortcutDetails

解析 shortcutPath 处的快捷方式链接。

发生任何错误时都会抛出异常。