electron/docs/api/shell.md

45 lines
899 B
Markdown
Raw Normal View History

2013-09-09 07:35:57 +00:00
# shell
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
const shell = require('electron').shell;
2015-08-29 05:28:30 +00:00
2013-08-14 22:43:35 +00:00
shell.openExternal('https://github.com');
```
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.
2015-08-29 05:28:30 +00:00
### `shell.openExternal(url)`
2013-08-14 22:43:35 +00:00
* `url` String
Open the given external protocol URL in the desktop's default manner. (For
2015-08-29 05:28:30 +00:00
example, mailto: URLs in the user's default mail agent.)
2013-08-14 22:43:35 +00:00
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
Play the beep sound.