Commit Graph

14 Commits

Author SHA1 Message Date
Indrek Ardel
55f3311c01 Remove unused variables 2016-09-26 20:52:13 +03:00
Ross Allen
7e75b861d8 Describe whitespace in detail and description
`detail` is rendered as preformatted text in core themes. `description`
is rendered as Markdown.
2016-06-30 15:57:22 -07:00
Ross Allen
752359b332 Clarify buttonClass and description 2016-06-21 08:22:05 -07:00
Ross Allen
86cdc61ff0 Correctly reference onDidClick, not onClick 2016-06-14 07:36:35 -07:00
Ross Allen
c19ed79066 Complete documentation for Notification creation
Notifications support several options that were yet to be documented:
`buttons`, `description`, and `stack`. Add descriptions for each option
and its defaults (where applicable, e.g. .buttons.className).

`stack` is technically available on all notification types, but it
doesn't make sense to use it on types other than 'error' and 'fatal'.
Therefore it's documented only in those two cases.

The usage and expected display, like preformatted vs. Markdown, taken
from [atom/notifications/lib/notification-element.coffee][1].

[1]: https://github.com/atom/notifications/blob/v0.64.1/lib/notification-element.coffee
2016-06-14 07:36:35 -07:00
Lee Dohm
5fc111a104 📝 Add standard global notation 2016-03-26 15:50:07 -07:00
Max Brunsfeld
10b8de6fc4 Merge pull request #8533 from ssorallen/notification-manager-options-docs
Document all options for creating Notifications
2015-10-13 13:56:41 -07:00
Ross Allen
5ac106dc9c Document all options for creating Notifications
The defaults for the 'icon' values come from Notification::getIcon[0].

[0]:
https://github.com/atom/atom/blob/v1.0.7/src/notification.coffee#L79
2015-09-01 22:59:00 -07:00
Devon Carew
a235fcb8aa Update notification-manager.coffee
Fix a broken link in the docs page for https://atom.io/docs/api/v1.0.10/NotificationManager.
2015-09-01 21:28:16 -07:00
Kevin Sawicki
05fdc85282 Mark getNotifications as public and return an array copy 2015-04-23 16:10:31 -07:00
Kevin Sawicki
1cd5bb0f8d Mark NotificationManager public and add docs 2015-04-23 16:10:31 -07:00
Ben Ogle
48e6cd533d Add wasDisplayed to Notification 2015-01-09 17:35:26 -08:00
Ben Ogle
5cf97db07c Add getNotifications() 2014-12-05 13:46:01 -08:00
Ben Ogle
9c6a5fb4fa Messages -> notifications 2014-11-24 14:58:21 -08:00