2013-09-09 07:35:57 +00:00
|
|
|
# shell
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2016-04-21 22:39:12 +00:00
|
|
|
> Manage files and URLs using their default applications.
|
2016-04-21 22:35:29 +00:00
|
|
|
|
2013-08-14 22:43:35 +00:00
|
|
|
The `shell` module provides functions related to desktop integration.
|
|
|
|
|
2015-08-29 05:28:30 +00:00
|
|
|
An example of opening a URL in the user's default browser:
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
const {shell} = require('electron')
|
2015-08-29 05:28:30 +00:00
|
|
|
|
2016-07-26 01:39:25 +00:00
|
|
|
shell.openExternal('https://github.com')
|
2013-08-14 22:43:35 +00:00
|
|
|
```
|
|
|
|
|
2015-08-29 05:28:30 +00:00
|
|
|
## Methods
|
|
|
|
|
|
|
|
The `shell` module has the following methods:
|
|
|
|
|
|
|
|
### `shell.showItemInFolder(fullPath)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
* `fullPath` String
|
|
|
|
|
|
|
|
Show the given file in a file manager. If possible, select the file.
|
|
|
|
|
2015-08-29 05:28:30 +00:00
|
|
|
### `shell.openItem(fullPath)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
* `fullPath` String
|
|
|
|
|
|
|
|
Open the given file in the desktop's default manner.
|
|
|
|
|
2016-02-03 07:01:00 +00:00
|
|
|
### `shell.openExternal(url[, options])`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
* `url` String
|
2016-06-18 13:26:26 +00:00
|
|
|
* `options` Object (optional) _macOS_
|
2016-02-16 23:58:33 +00:00
|
|
|
* `activate` Boolean - `true` to bring the opened application to the
|
|
|
|
foreground. The default is `true`.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
Open the given external protocol URL in the desktop's default manner. (For
|
2016-02-03 07:01:00 +00:00
|
|
|
example, mailto: URLs in the user's default mail agent.) Returns true if an
|
|
|
|
application was available to open the URL, false otherwise.
|
|
|
|
|
2015-08-29 05:28:30 +00:00
|
|
|
### `shell.moveItemToTrash(fullPath)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
* `fullPath` String
|
|
|
|
|
2015-08-29 05:28:30 +00:00
|
|
|
Move the given file to trash and returns a boolean status for the operation.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-08-29 05:28:30 +00:00
|
|
|
### `shell.beep()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
Play the beep sound.
|