Browse Source

add detail for the browserWindow argument in dialog docs

David Ferguson 8 years ago
parent
commit
32ae3a52b8
1 changed files with 6 additions and 0 deletions
  1. 6 0
      docs/api/dialog.md

+ 6 - 0
docs/api/dialog.md

@@ -41,6 +41,8 @@ The `dialog` module has the following methods:
 Returns `String[]`, an array of file paths chosen by the user,
 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
 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,
 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
 `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.
 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
 will be passed via `callback(response)`.