New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: MessageBoxOptions.icon should allow type string #19782
Conversation
💖 Thanks for opening this pull request! 💖 We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix. Examples of commit messages with semantic prefixes:
Things that will help get your PR across the finish line:
We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess that's not the only occurrence that should be changed in our docs - but let's start somewhere. Thank you for your contribution 🎉
Thank you! Is there any chance that it can be backported to |
@jpmn yes! |
Congrats on merging your first pull request! 🎉🎉🎉 |
Release Notes Persisted
|
I have automatically backported this PR to "5-0-x", please check out #19796 |
I have automatically backported this PR to "7-0-x", please check out #19797 |
I have automatically backported this PR to "6-0-x", please check out #19798 |
) Fixes electron#32390. See electron#19782 for context.
Description of Change
In the
dialog
documentation (and the generated typings inelectron.d.ts
), it is mentionned that theicon
property only supportsNativeImage
, but thenativeImage
documentation says that:This PR adds support for the type
string
through a change in the documentation to matchBrowserWindowConstructorOptions.icon?: (NativeImage) | (string);
fromelectron.d.ts
. This change should result inMessageBoxOptions.icon?: NativeImage;
becomingMessageBoxOptions.icon?: (NativeImage) | (string);
Related documentation:
https://electronjs.org/docs/api/dialog#dialogshowmessageboxbrowserwindow-options
https://electronjs.org/docs/api/browser-window#new-browserwindowoptions
https://electronjs.org/docs/api/native-image#nativeimage
Checklist
npm test
passesRelease Notes
Notes: Allowed
string
as type onMessageBoxOptions.icon
to support file paths as mentioned inNativeImage
documentation