跳到主内容

shell

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

Process: Main, Renderer (只能在非沙盒下使用)

shell 模块提供与桌面集成相关的功能。

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

const { shell } = require('electron')

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

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

方法

shell 模块具有以下方法:

shell.showItemInFolder(fullPath)

  • fullPath String

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

shell.openPath(path)

  • path String

返回 Promise<String> - 如若发生故障,则返回一个带有错误信息的字符串,正常则返回空字符串

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

shell.openExternal(url[, options])

  • url String - 在 windows 平台最大 2081 字符。
  • options Object (可选)
    • activate Boolean (可选) macOS - true 会将打开的应用程序置于前台。 默认值为 true
    • workingDirectory字符串 (可选的) Windows - 工作目录

返回 Promise<void>

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

shell.trashItem(path)

  • path String - 要移动到回收站的项目路径.

Returns Promise<void> - 操作完成时正常解析。 删除项目错误时拒绝。

这将移动路径到操作系统特定的垃圾位置 (macOS 上的 Trash、Windows 上的 Recycle Bin 以及 Linux 上的桌面环境特定位置) 。

shell.beep()

播放哔哔的声音.

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

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

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

shortcutPath位置创建或更新一个快捷连接

shell.readShortcutLink(shortcutPath) Windows

  • shortcutPath String

返回 ShortcutDetails

解析shortcutPath中的快捷链接。

发生任何错误时将引发异常。