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

docs: put required field frontmost in the dialog options (#26059)

Browse source
This commit is contained in:
Cheng Zhao 2020-10-21 20:07:44 +09:00 • committed by GitHub
parent 5c6fa7e420
commit a631a8a8b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api/dialog.md
View file

@ -221,6 +221,7 @@ expanding and collapsing the dialog.
* `browserWindow` [BrowserWindow](browser-window.md) (optional) * `browserWindow` [BrowserWindow](browser-window.md) (optional)
* `options` Object * `options` Object
* `message` String - Content of the message box.
* `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or * `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or
`"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
@ -230,7 +231,6 @@ expanding and collapsing the dialog.
* `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.
* `title` String (optional) - Title of the message box, some platforms will not show it. * `title` String (optional) - Title of the message box, some platforms will not show it.
* `message` String - Content of the message box.
* `detail` String (optional) - Extra information of the message. * `detail` String (optional) - Extra information of the message.
* `checkboxLabel` String (optional) - If provided, the message box will * `checkboxLabel` String (optional) - If provided, the message box will
include a checkbox with the given label. include a checkbox with the given label.
@ -267,6 +267,7 @@ If `browserWindow` is not shown dialog will not be attached to it. In such case
* `browserWindow` [BrowserWindow](browser-window.md) (optional) * `browserWindow` [BrowserWindow](browser-window.md) (optional)
* `options` Object * `options` Object
* `message` String - Content of the message box.
* `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or * `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or
`"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
@ -276,7 +277,6 @@ If `browserWindow` is not shown dialog will not be attached to it. In such case
* `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.
* `title` String (optional) - Title of the message box, some platforms will not show it. * `title` String (optional) - Title of the message box, some platforms will not show it.
* `message` String - Content of the message box.
* `detail` String (optional) - Extra information of the message. * `detail` String (optional) - Extra information of the message.
* `checkboxLabel` String (optional) - If provided, the message box will * `checkboxLabel` String (optional) - If provided, the message box will
include a checkbox with the given label. include a checkbox with the given label.