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

add detail for the browserWindow argument in dialog docs

Browse source
This commit is contained in:
David Ferguson 2016-12-06 22:23:14 -06:00
parent f1f73eff04
commit 32ae3a52b8
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/api/dialog.md
View file

@ -41,6 +41,8 @@ The `dialog` module has the following methods:
Returns `String[]`, an array of file paths chosen by the user, Returns `String[]`, an array of file paths chosen by the user,
if the callback is provided it returns `undefined`. if the callback is provided it returns `undefined`.
The `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.
The `filters` specifies an array of file types that can be displayed or The `filters` specifies an array of file types that can be displayed or
selected when you want to limit the user to a specific type. For example: selected when you want to limit the user to a specific type. For example:
@ -82,6 +84,8 @@ shown.
Returns `String`, the path of the file chosen by the user, Returns `String`, the path of the file chosen by the user,
if a callback is provided it returns `undefined`. if a callback is provided it returns `undefined`.
The `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.
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.
@ -122,6 +126,8 @@ it returns undefined.
Shows a message box, it will block the process until the message box is closed. Shows a message box, it will block the process until the message box is closed.
It returns the index of the clicked button. It returns the index of the clicked button.
The `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.
If a `callback` is passed, the API call will be asynchronous and the result If a `callback` is passed, the API call will be asynchronous and the result
will be passed via `callback(response)`. will be passed via `callback(response)`.