github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix typing of message box type value (#38376)

Browse Source 
docs: fix typing of message box type value (#38336)

* docs: fix typing of dialog type value

* test: add smoke tests

* test: update test
This commit is contained in:
David Sanders
2023-05-22 04:20:25 -07:00
committed by GitHub
parent d5e1edf244
commit def64aba17
3 changed files with 27 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/api/dialog.md
View File

@@ -223,10 +223,10 @@ expanding and collapsing the dialog.
* `browserWindow` [BrowserWindow](browser-window.md) (optional)
* `options` Object
* `message` string - Content of the message box.
* `type` string (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or
`"warning"`. On Windows, `"question"` displays the same icon as `"info"`, unless
you set an icon using the `"icon"` option. On macOS, both `"warning"` and
`"error"` display the same warning icon.
* `type` string (optional) - Can be `none`, `info`, `error`, `question` or
`warning`. On Windows, `question` displays the same icon as `info`, unless
you set an icon using the `icon` option. On macOS, both `warning` and
`error` display the same warning icon.
* `buttons` string[] (optional) - Array of texts for buttons. On Windows, an empty array
will result in one button labeled "OK".
* `defaultId` Integer (optional) - Index of the button in the buttons array which will
@@ -266,10 +266,10 @@ If `browserWindow` is not shown dialog will not be attached to it. In such case
* `browserWindow` [BrowserWindow](browser-window.md) (optional)
* `options` Object
* `message` string - Content of the message box.
* `type` string (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or
`"warning"`. On Windows, `"question"` displays the same icon as `"info"`, unless
you set an icon using the `"icon"` option. On macOS, both `"warning"` and
`"error"` display the same warning icon.
* `type` string (optional) - Can be `none`, `info`, `error`, `question` or
`warning`. On Windows, `question` displays the same icon as `info`, unless
you set an icon using the `icon` option. On macOS, both `warning` and
`error` display the same warning icon.
* `buttons` string[] (optional) - Array of texts for buttons. On Windows, an empty array
will result in one button labeled "OK".
* `defaultId` Integer (optional) - Index of the button in the buttons array which will

2
spec/api-dialog-spec.ts
View File

@@ -96,7 +96,7 @@ describe('dialog module', () => {
it('throws errors when the options are invalid', () => {
expect(() => {
dialog.showMessageBox(undefined as any, { type: 'not-a-valid-type', message: '' });
dialog.showMessageBox(undefined as any, { type: 'not-a-valid-type' as any, message: '' });
}).to.throw(/Invalid message box type/);
expect(() => {

18
spec/ts-smoke/electron/main.ts
View File

@@ -506,6 +506,24 @@ dialog.showOpenDialog(win3, {
console.log(ret)
})
// variants without browserWindow
dialog.showMessageBox({ message: 'test', type: 'warning' })
dialog.showMessageBoxSync({ message: 'test', type: 'error' })
// @ts-expect-error Invalid type value
dialog.showMessageBox({ message: 'test', type: 'foo' })
// @ts-expect-error Invalid type value
dialog.showMessageBoxSync({ message: 'test', type: 'foo' })
// variants with browserWindow
dialog.showMessageBox(win3, { message: 'test', type: 'question' })
dialog.showMessageBoxSync(win3, { message: 'test', type: 'info' })
// @ts-expect-error Invalid type value
dialog.showMessageBox(win3, { message: 'test', type: 'foo' })
// @ts-expect-error Invalid type value
dialog.showMessageBoxSync(win3, { message: 'test', type: 'foo' })
// global-shortcut
// https://github.com/electron/electron/blob/master/docs/api/global-shortcut.md