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

docs: MessageBoxOptions.icon should allow type string (#19782)

Browse source 
In the `dialog` documentation (and the generated typings in `electron.d.ts`), it is mentionned that the `icon` property only supports `NativeImage`, but the `nativeImage` documentation says that:

```
In Electron, for the APIs that take images, you can pass either file paths or NativeImage
```
This commit is contained in:
Jean-Philippe Morin 2019-08-16 11:06:02 -04:00 committed by Alexey Kuzmin
parent 2595cb5698
commit 42ac64284f
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/dialog.md
View file

@ -242,7 +242,7 @@ expanding and collapsing the dialog.
include a checkbox with the given label. include a checkbox with the given label.
* `checkboxChecked` Boolean (optional) - Initial checked state of the * `checkboxChecked` Boolean (optional) - Initial checked state of the
checkbox. `false` by default. checkbox. `false` by default.
* `icon` [NativeImage](native-image.md) (optional) * `icon` ([NativeImage](native-image.md) | String) (optional)
* `cancelId` Integer (optional) - The index of the button to be used to cancel the dialog, via * `cancelId` Integer (optional) - The index of the button to be used to cancel the dialog, via
the `Esc` key. By default this is assigned to the first button with "cancel" or "no" as the the `Esc` key. By default this is assigned to the first button with "cancel" or "no" as the
label. If no such labeled buttons exist and this option is not set, `0` will be used as the label. If no such labeled buttons exist and this option is not set, `0` will be used as the