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

Merge pull request #1894 from samccone/patch-5

Browse source 
📝 Fix english errors and language
This commit is contained in:
Cheng Zhao 2015-06-08 22:31:17 +08:00
commit 676cfa03a1
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/api/dialog.md
View file

@ -1,7 +1,7 @@
# dialog # dialog
The `dialog` module provides APIs to show native system dialogs, so web The `dialog` module provides APIs to show native system dialogs, so web
applications can get the same user experience with native applications. applications can deliver the same user experience as native applications.
An example of showing a dialog to select multiple files and directories: An example of showing a dialog to select multiple files and directories:
@ -11,7 +11,7 @@ var dialog = require('dialog');
console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]}));
``` ```
**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is to provide a `BrowserWindow` reference in the `browserWindow` parameter. **Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter.
## dialog.showOpenDialog([browserWindow], [options], [callback]) ## dialog.showOpenDialog([browserWindow], [options], [callback])
@ -44,10 +44,9 @@ selected, an example is:
If a `callback` is passed, the API call would be asynchronous and the result If a `callback` is passed, the API call would be asynchronous and the result
would be passed via `callback(filenames)` would be passed via `callback(filenames)`
**Note:** On Windows and Linux, an open dialog could not be both file selector **Note:** On Windows and Linux, an open dialog can not be both a file selector
and directory selector at the same time, so if you set `properties` to and a directory selector, so if you set `properties` to
`['openFile', 'openDirectory']` on these platforms, a directory selector would `['openFile', 'openDirectory']` on these platforms, a directory selector will be shown.
be showed.
## dialog.showSaveDialog([browserWindow], [options], [callback]) ## dialog.showSaveDialog([browserWindow], [options], [callback])
@ -58,14 +57,14 @@ be showed.
* `filters` Array * `filters` Array
* `callback` Function * `callback` Function
On success, returns the path of file chosen by the user, otherwise returns On success, returns the path of the file chosen by the user, otherwise returns
`undefined`. `undefined`.
The `filters` specifies an array of file types that can be displayed, see The `filters` specifies an array of file types that can be displayed, see
`dialog.showOpenDialog` for an example. `dialog.showOpenDialog` for an example.
If a `callback` is passed, the API call would be asynchronous and the result If a `callback` is passed, the API call will be asynchronous and the result
would be passed via `callback(filename)` will be passed via `callback(filename)`
## dialog.showMessageBox([browserWindow], options, [callback]) ## dialog.showMessageBox([browserWindow], options, [callback])
@ -82,8 +81,8 @@ would be passed via `callback(filename)`
Shows a message box, it will block until the message box is closed. It returns Shows a message box, it will block until the message box is closed. It returns
the index of the clicked button. the index of the clicked button.
If a `callback` is passed, the API call would be asynchronous and the result If a `callback` is passed, the API call will be asynchronous and the result
would be passed via `callback(response)` will be passed via `callback(response)`
## dialog.showErrorBox(title, content) ## dialog.showErrorBox(title, content)