1.7 KiB
1.7 KiB
Synopsis
The dialog
module provides functions to show system dialogs, so web
applications can get the same user experience with native applications.
An example of showing a dialog to select multiple files and directories:
var win = ...; // window in which to show the dialog
var dialog = require('dialog');
console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]}));
dialog.showOpenDialog(options)
options
Objecttitle
StringdefaultPath
Stringproperties
Array - Contains which features the dialog should use, can containopenFile
,openDirectory
,multiSelections
andcreateDirectory
On success, returns an array of file paths chosen by the user, otherwise
returns undefined
.
Note: The dialog.showOpenDialog
API is synchronous and blocks all windows.
dialog.showSaveDialog(browserWindow, options)
browserWindow
BrowserWindowoptions
Objecttitle
StringdefaultPath
String
On success, returns the path of file chosen by the user, otherwise returns
undefined
.
Note: The dialog.showSaveDialog
API is synchronous and blocks all windows.
dialog.showMessageBox([browserWindow], options)
browserWindow
BrowserWindowoptions
Objecttype
String - Can be"none"
,"info"
or"warning"
buttons
Array - Array of texts for buttonstitle
String - Title of the message box, some platforms will not show itmessage
String - Content of the message boxdetail
String - Extra information of the message
Shows a message box, it will block until the message box is closed. It returns the index of the clicked button.
Note: The dialog.showMessageBox
API is synchronous and blocks all windows.