From 42ac64284f19d165377cf0b060944027f9d7c70c Mon Sep 17 00:00:00 2001 From: Jean-Philippe Morin Date: Fri, 16 Aug 2019 11:06:02 -0400 Subject: [PATCH] docs: MessageBoxOptions.icon should allow type string (#19782) 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 ``` --- docs/api/dialog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 6e3065f5fd..855f72c022 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -242,7 +242,7 @@ expanding and collapsing the dialog. include a checkbox with the given label. * `checkboxChecked` Boolean (optional) - Initial checked state of the 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 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