github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-09 15:38:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): fix 'optional' wording

Browse Source
This commit is contained in:
Toinane
2017-11-28 18:15:15 +01:00
parent 124667c29b
commit 59607c9a17
14 changed files with 92 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api/notification.md
View File

@@ -31,14 +31,14 @@ Returns `Boolean` - Whether or not desktop notifications are supported on the cu
* `options` Object
* `title` String - A title for the notification, which will be shown at the top of the notification window when it is shown
* `subtitle` String - (optional) A subtitle for the notification, which will be displayed below the title. _macOS_
* `subtitle` String (optional) - A subtitle for the notification, which will be displayed below the title. _macOS_
* `body` String - The body text of the notification, which will be displayed below the title or subtitle
* `silent` Boolean - (optional) Whether or not to emit an OS notification noise when showing the notification
* `icon` (String | [NativeImage](native-image.md)) - (optional) An icon to use in the notification
* `hasReply` Boolean - (optional) Whether or not to add an inline reply option to the notification. _macOS_
* `replyPlaceholder` String - (optional) The placeholder to write in the inline reply input field. _macOS_
* `sound` String - (optional) The name of the sound file to play when the notification is shown. _macOS_
* `actions` [NotificationAction[]](structures/notification-action.md) - (optional) Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_
* `silent` Boolean (optional) - Whether or not to emit an OS notification noise when showing the notification
* `icon` (String | [NativeImage](native-image.md)) (optional) - An icon to use in the notification
* `hasReply` Boolean (optional) - Whether or not to add an inline reply option to the notification. _macOS_
* `replyPlaceholder` String (optional) - The placeholder to write in the inline reply input field. _macOS_
* `sound` String (optional) - The name of the sound file to play when the notification is shown. _macOS_
* `actions` [NotificationAction[]](structures/notification-action.md) (optional) - Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_
### Instance Events