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

Document new settings

Browse source
This commit is contained in:
Kevin Sawicki 2017-02-09 11:29:10 -08:00
parent f7f4de36af
commit 35654d872b
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/dialog.md
View file

@ -51,7 +51,8 @@ The `dialog` module has the following methods:
untouched on Windows. For example, a button label of `Vie&w` will be untouched on Windows. For example, a button label of `Vie&w` will be
converted to `Vie_w` on Linux and `View` on macOS and can be selected converted to `Vie_w` on Linux and `View` on macOS and can be selected
via `Alt-W` on Windows and Linux. via `Alt-W` on Windows and Linux.
* `message` (optional) _macOS_ * `message` String (optional) _macOS_ - Message to display above input
boxes.
* `callback` Function (optional) * `callback` Function (optional)
* `filePaths` String[] - An array of file paths chosen by the user * `filePaths` String[] - An array of file paths chosen by the user
@ -95,10 +96,11 @@ shown.
* `buttonLabel` String (optional) - Custom label for the confirmation button, when * `buttonLabel` String (optional) - Custom label for the confirmation button, when
left empty the default label will be used. left empty the default label will be used.
* `filters` [FileFilter[]](structures/file-filter.md) (optional) * `filters` [FileFilter[]](structures/file-filter.md) (optional)
* `message` (optional) _macOS_ * `message` String (optional) _macOS_ - Message to display above text fields.
* `nameFieldLabel` String (optional) _macOS_ - Custom label for the string displayed * `nameFieldLabel` String (optional) _macOS_ - Custom label for the text
in front of the filename text field. displayed in front of the filename text field.
* `showsTagField` Boolean (optional) _macOS_ * `showsTagField` Boolean (optional) _macOS_ - Show the tags input box,
defaults to `true`.
* `callback` Function (optional) * `callback` Function (optional)
* `filename` String * `filename` String