From d200cf2e7705eb503d76a90b29947bde75553b4e Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 29 Dec 2016 13:18:50 -0800 Subject: [PATCH] Document normalizeAccessKeys option --- docs/api/dialog.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 8ee8582c97..18f1fc6b07 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -35,6 +35,14 @@ The `dialog` module has the following methods: * `properties` String[] (optional) - Contains which features the dialog should use, can contain `openFile`, `openDirectory`, `multiSelections`, `createDirectory` and `showHiddenFiles`. + * `normalizeAccessKeys` Boolean (optional) - Normalize the keyboard access keys + across platforms. Default is `false`. Enabling this assumes `&` is used in + the button labels for the placement of the keyboard shortcut access key + and labels will be converted so they work correctly on each platform, `&` + characters are removed on macOS, converted to `_` on Linux, and left + 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. * `callback` Function (optional) * `filePaths` String[] - An array of file paths chosen by the user