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

fix(docs): fix all missing dots and add some links

Browse source
This commit is contained in:
Toinane 2017-11-29 11:38:35 +01:00
parent 59607c9a17
commit 323ea2b27b
No known key found for this signature in database
GPG key ID: 1A3729C1B6D59115
24 changed files with 148 additions and 148 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/api/notification.md
View file

@ -30,15 +30,15 @@ Returns `Boolean` - Whether or not desktop notifications are supported on the cu
### `new Notification([options])` _Experimental_
* `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_
* `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_
* `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) _macOS_ - A subtitle for the notification, which will be displayed below the title.
* `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) _macOS_ - Whether or not to add an inline reply option to the notification.
* `replyPlaceholder` String (optional) _macOS_ - The placeholder to write in the inline reply input field.
* `sound` String (optional) _macOS_ - The name of the sound file to play when the notification is shown.
* `actions` [NotificationAction[]](structures/notification-action.md) (optional) _macOS_ - Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation.
### Instance Events
@ -82,7 +82,7 @@ is closed.
Returns:
* `event` Event
* `reply` String - The string the user entered into the inline reply field
* `reply` String - The string the user entered into the inline reply field.
Emitted when the user clicks the "Reply" button on a notification with `hasReply: true`.
@ -91,7 +91,7 @@ Emitted when the user clicks the "Reply" button on a notification with `hasReply
Returns:
* `event` Event
* `index` Number - The index of the action that was activated
* `index` Number - The index of the action that was activated.
### Instance Methods