From 35654d872b544699a5f065a66371c6f652513bbb Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 9 Feb 2017 11:29:10 -0800 Subject: [PATCH] Document new settings --- docs/api/dialog.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 10326731aa13..75edc26bdc8a 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -51,7 +51,8 @@ The `dialog` module has the following methods: 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 via `Alt-W` on Windows and Linux. - * `message` (optional) _macOS_ + * `message` String (optional) _macOS_ - Message to display above input + boxes. * `callback` Function (optional) * `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 left empty the default label will be used. * `filters` [FileFilter[]](structures/file-filter.md) (optional) - * `message` (optional) _macOS_ - * `nameFieldLabel` String (optional) _macOS_ - Custom label for the string displayed - in front of the filename text field. - * `showsTagField` Boolean (optional) _macOS_ + * `message` String (optional) _macOS_ - Message to display above text fields. + * `nameFieldLabel` String (optional) _macOS_ - Custom label for the text + displayed in front of the filename text field. + * `showsTagField` Boolean (optional) _macOS_ - Show the tags input box, + defaults to `true`. * `callback` Function (optional) * `filename` String