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

docs: fix broken markdown in dialog.md (#29782)

Browse source
This commit is contained in:
Jeremy Rose 2021-06-22 09:49:30 -07:00 committed by GitHub
parent 92901ddf18
commit c5066cce22
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/api/dialog.md
View file

@ -24,7 +24,7 @@ The `dialog` module has the following methods:
* `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)
* `properties` String[] (optional) - Contains which features the dialog should * `properties` String[] (optional) - Contains which features the dialog should
use. The following values are supported: use. The following values are supported:
* `openFile` - Allow files to be selected. * `openFile` - Allow files to be selected.
* `openDirectory` - Allow directories 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 * `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)
* `properties` String[] (optional) - Contains which features the dialog should * `properties` String[] (optional) - Contains which features the dialog should
use. The following values are supported: use. The following values are supported:
* `openFile` - Allow files to be selected. * `openFile` - Allow files to be selected.
* `openDirectory` - Allow directories 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. * `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. * `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[]&#32;(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. 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. displayed in front of the filename text field.
* `showsTagField` Boolean (optional) _macOS_ - Show the tags input box, * `showsTagField` Boolean (optional) _macOS_ - Show the tags input box,
defaults to `true`. defaults to `true`.
* `properties` String[] (optional) * `properties` String[]&#32;(optional)
* `showHiddenFiles` - Show hidden files in dialog. * `showHiddenFiles` - Show hidden files in dialog.
* `createDirectory` _macOS_ - Allow creating new directories from dialog. * `createDirectory` _macOS_ - Allow creating new directories from dialog.
* `treatPackageAsDirectory` _macOS_ - Treat packages, such as `.app` folders, * `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 * `nameFieldLabel` String (optional) _macOS_ - Custom label for the text
displayed in front of the filename text field. displayed in front of the filename text field.
* `showsTagField` Boolean (optional) _macOS_ - Show the tags input box, defaults to `true`. * `showsTagField` Boolean (optional) _macOS_ - Show the tags input box, defaults to `true`.
* `properties` String[] (optional) * `properties` String[]&#32;(optional)
* `showHiddenFiles` - Show hidden files in dialog. * `showHiddenFiles` - Show hidden files in dialog.
* `createDirectory` _macOS_ - Allow creating new directories from dialog. * `createDirectory` _macOS_ - Allow creating new directories from dialog.
* `treatPackageAsDirectory` _macOS_ - Treat packages, such as `.app` folders, * `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 `"warning"`. On Windows, `"question"` displays the same icon as `"info"`, unless
you set an icon using the `"icon"` option. On macOS, both `"warning"` and you set an icon using the `"icon"` option. On macOS, both `"warning"` and
`"error"` display the same warning icon. `"error"` display the same warning icon.
* `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array * `buttons` String[]&#32;(optional) - Array of texts for buttons. On Windows, an empty array
will result in one button labeled "OK". will result in one button labeled "OK".
* `defaultId` Integer (optional) - Index of the button in the buttons array which will * `defaultId` Integer (optional) - Index of the button in the buttons array which will
be selected by default when the message box opens. be selected by default when the message box opens.
@ -269,7 +269,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 `"warning"`. On Windows, `"question"` displays the same icon as `"info"`, unless
you set an icon using the `"icon"` option. On macOS, both `"warning"` and you set an icon using the `"icon"` option. On macOS, both `"warning"` and
`"error"` display the same warning icon. `"error"` display the same warning icon.
* `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array * `buttons` String[]&#32;(optional) - Array of texts for buttons. On Windows, an empty array
will result in one button labeled "OK". will result in one button labeled "OK".
* `defaultId` Integer (optional) - Index of the button in the buttons array which will * `defaultId` Integer (optional) - Index of the button in the buttons array which will
be selected by default when the message box opens. be selected by default when the message box opens.