|
@@ -24,7 +24,7 @@ The `dialog` module has the following methods:
|
|
|
* `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)
|
|
|
- * `properties` String[] (optional) - Contains which features the dialog should
|
|
|
+ * `properties` String[] (optional) - Contains which features the dialog should
|
|
|
use. The following values are supported:
|
|
|
* `openFile` - Allow files to be selected.
|
|
|
* `openDirectory` - Allow directories to be selected.
|
|
@@ -87,7 +87,7 @@ dialog.showOpenDialogSync(mainWindow, {
|
|
|
* `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)
|
|
|
- * `properties` String[] (optional) - Contains which features the dialog should
|
|
|
+ * `properties` String[] (optional) - Contains which features the dialog should
|
|
|
use. The following values are supported:
|
|
|
* `openFile` - Allow files to be selected.
|
|
|
* `openDirectory` - Allow directories to be selected.
|
|
@@ -112,7 +112,7 @@ Returns `Promise<Object>` - Resolve with an object containing the following:
|
|
|
|
|
|
* `canceled` Boolean - whether or not the dialog was canceled.
|
|
|
* `filePaths` String[] - An array of file paths chosen by the user. If the dialog is cancelled this will be an empty array.
|
|
|
-* `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the `filePaths` array of base64 encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated. (For return values, see [table here](#bookmarks-array).)
|
|
|
+* `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the `filePaths` array of base64 encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated. (For return values, see [table here](#bookmarks-array).)
|
|
|
|
|
|
The `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.
|
|
|
|
|
@@ -165,7 +165,7 @@ dialog.showOpenDialog(mainWindow, {
|
|
|
displayed in front of the filename text field.
|
|
|
* `showsTagField` Boolean (optional) _macOS_ - Show the tags input box,
|
|
|
defaults to `true`.
|
|
|
- * `properties` String[] (optional)
|
|
|
+ * `properties` String[] (optional)
|
|
|
* `showHiddenFiles` - Show hidden files in dialog.
|
|
|
* `createDirectory` _macOS_ - Allow creating new directories from dialog.
|
|
|
* `treatPackageAsDirectory` _macOS_ - Treat packages, such as `.app` folders,
|
|
@@ -195,7 +195,7 @@ The `filters` specifies an array of file types that can be displayed, see
|
|
|
* `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`.
|
|
|
- * `properties` String[] (optional)
|
|
|
+ * `properties` String[] (optional)
|
|
|
* `showHiddenFiles` - Show hidden files in dialog.
|
|
|
* `createDirectory` _macOS_ - Allow creating new directories from dialog.
|
|
|
* `treatPackageAsDirectory` _macOS_ - Treat packages, such as `.app` folders,
|
|
@@ -227,7 +227,7 @@ expanding and collapsing the dialog.
|
|
|
`"warning"`. On Windows, `"question"` displays the same icon as `"info"`, unless
|
|
|
you set an icon using the `"icon"` option. On macOS, both `"warning"` and
|
|
|
`"error"` display the same warning icon.
|
|
|
- * `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array
|
|
|
+ * `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array
|
|
|
will result in one button labeled "OK".
|
|
|
* `defaultId` Integer (optional) - Index of the button in the buttons array which will
|
|
|
be selected by default when the message box opens.
|
|
@@ -273,7 +273,7 @@ If `browserWindow` is not shown dialog will not be attached to it. In such case
|
|
|
`"warning"`. On Windows, `"question"` displays the same icon as `"info"`, unless
|
|
|
you set an icon using the `"icon"` option. On macOS, both `"warning"` and
|
|
|
`"error"` display the same warning icon.
|
|
|
- * `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array
|
|
|
+ * `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array
|
|
|
will result in one button labeled "OK".
|
|
|
* `defaultId` Integer (optional) - Index of the button in the buttons array which will
|
|
|
be selected by default when the message box opens.
|