mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Use markdown list for new options param

Browse source
This commit is contained in:
Kevin Sawicki 2016-02-16 15:58:33 -08:00
parent f5bed87199
commit 42041cd402
1 changed files with 3 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api/shell.md
View file

@ -29,16 +29,14 @@ Open the given file in the desktop's default manner.
### `shell.openExternal(url[, options])` ### `shell.openExternal(url[, options])`
* `url` String * `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 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 example, mailto: URLs in the user's default mail agent.) Returns true if an
application was available to open the URL, false otherwise. application was available to open the URL, false otherwise.
On Mac OS X, you can pass additional options to openExternal:
- withoutActivation: Pass true to open the URL without bringing the
application into the foreground.
### `shell.moveItemToTrash(fullPath)` ### `shell.moveItemToTrash(fullPath)`
* `fullPath` String * `fullPath` String