From 32ae3a52b8e43a412c2590c32eeba45cafa70f1d Mon Sep 17 00:00:00 2001 From: David Ferguson Date: Tue, 6 Dec 2016 22:23:14 -0600 Subject: [PATCH] add detail for the browserWindow argument in dialog docs --- docs/api/dialog.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 97ab1e212a6..d84eb384b61 100644 --- a/docs/api/dialog.md +++ b/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)`.