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

Update docs to contain more specific return values

Browse source
This commit is contained in:
Samuel Attard 2016-09-28 18:28:44 +13:00 • committed by Samuel Attard
parent 5114d571df
commit e0e47ea9a1
11 changed files with 28 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api/dialog.md
View file

@ -29,8 +29,8 @@ The `dialog` module has the following methods:
* `defaultPath` String
* `buttonLabel` String - Custom label for the confirmation button, when
left empty the default label will be used.
* `filters` Array
* `properties` Array - Contains which features the dialog should use, can
* `filters` String[]
* `properties` String[] - Contains which features the dialog should use, can
contain `openFile`, `openDirectory`, `multiSelections`, `createDirectory`
and `showHiddenFiles`.
* `callback` Function (optional)
@ -72,7 +72,7 @@ shown.
* `defaultPath` String
* `buttonLabel` String - Custom label for the confirmation button, when
left empty the default label will be used.
* `filters` Array
* `filters` String[]
* `callback` Function (optional)
On success this method returns the path of the file chosen by the user,
@ -91,7 +91,7 @@ will be passed via `callback(filename)`
* `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or
`"warning"`. On Windows, "question" displays the same icon as "info", unless
you set an icon using the "icon" option.
* `buttons` Array - Array of texts for buttons. On Windows, an empty array
* `buttons` String[] - Array of texts for buttons. On Windows, an empty array
will result in one button labeled "OK".
* `defaultId` Integer - Index of the button in the buttons array which will
be selected by default when the message box opens.