mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1
electron/docs/api/shell.md
Kevin Sawicki 42041cd402 Use markdown list for new options param
2016-02-17 08:56:59 -08:00

1.1 KiB
Raw Blame History

shell

The shell module provides functions related to desktop integration.

An example of opening a URL in the user's default browser:

const shell = require('electron').shell;

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

Methods

The shell module has the following methods:

shell.showItemInFolder(fullPath)

  • fullPath String

Show the given file in a file manager. If possible, select the file.

shell.openItem(fullPath)

  • fullPath String

Open the given file in the desktop's default manner.

shell.openExternal(url[, options])

  • url String
  • options Object (optional) OS X
    • activate Boolean - true to bring the opened application to the foreground. The default is true.

Open the given external protocol URL in the desktop's default manner. (For example, mailto: URLs in the user's default mail agent.) Returns true if an application was available to open the URL, false otherwise.

shell.moveItemToTrash(fullPath)

  • fullPath String

Move the given file to trash and returns a boolean status for the operation.

shell.beep()

Play the beep sound.