• Packages
  • Themes
  • Documentation
  • Blog
  • Discuss
Sign in
Whoops, there was an error
v1.34.0
v1.33.1
v1.33.0
v1.32.2
v1.32.1
v1.32.0
v1.31.2
v1.31.1
v1.31.0
v1.30.0
v1.29.0
v1.28.2
v1.28.1
v1.28.0
untagged-688de6479cca05b51c00
untagged-2abd5a23b4430027c837
v1.27.2
v1.27.1
v1.27.0
v1.26.1
v1.26.0
v1.25.1
v1.25.0
v1.24.1
v1.24.0
v1.23.3
v1.23.2
v1.23.1
v1.23.0
v1.22.1
v1.22.0
v1.21.2
v1.21.1
v1.21.0
v1.20.1
v1.20.0
v1.19.7
v1.19.6
v1.19.5
v1.19.4
v1.19.3
v1.19.2
v1.19.1
v1.19.0
v1.18.0
v1.17.2
v1.17.1
v1.17.0
v1.16.0
v1.15.0
v1.14.4
v1.14.3
v1.14.2
v1.14.1
v1.14.0
v1.13.1
v1.13.0
v1.12.9
v1.12.8
v1.12.7
v1.12.6
v1.12.5
v1.12.4
v1.12.3
v1.12.2
v1.12.1
v1.12.0
v1.11.2
v1.11.1
v1.11.0
v1.10.2
v1.10.1
v1.10.0
v1.9.9
v1.9.8
v1.9.7
v1.9.6
v1.9.5
v1.9.4
v1.9.3
v1.9.2
v1.9.1
v1.9.0
v1.8.0
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.6.2
v1.6.1
v1.6.0
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.0
v1.0.19
v1.0.18
v1.0.17
v1.0.16
v1.0.15
v1.0.14
v1.0.13
v1.0.12
v1.0.11
v1.0.10
v1.0.9
v1.0.8
v1.0.7
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.211.0
v0.210.0
v0.209.0
v0.208.0
v0.207.0
v0.206.0
v0.205.0
v0.204.0
v0.203.0
v0.202.0
v0.201.0
v0.200.0
v0.199.0
v0.198.0
v0.197.0
v0.196.0
v0.195.0
v0.194.0
v0.193.0
v0.192.0
v0.191.0
v0.190.0
v0.189.0
v0.188.0
v0.187.0
Loading…

Essential Classes

  • AtomEnvironment
  • Color
  • CommandRegistry
  • CompositeDisposable
  • Config
  • Decoration
  • DisplayMarker
  • DisplayMarkerLayer
  • Disposable
  • Emitter
  • LayerDecoration
  • MarkerLayer
  • Notification
  • NotificationManager
  • Point
  • Range
  • TextEditor
  • TooltipManager
  • ViewRegistry
  • Workspace
  • WorkspaceCenter

Extended Classes

  • BufferedNodeProcess
  • BufferedProcess
  • Clipboard
  • ContextMenuManager
  • Cursor
  • DeserializerManager
  • Directory
  • Dock
  • File
  • GitRepository
  • Grammar
  • GrammarRegistry
  • Gutter
  • HistoryManager
  • KeymapManager
  • MenuManager
  • Package
  • PackageManager
  • Pane
  • Panel
  • PathWatcher
  • Project
  • ScopeDescriptor
  • Selection
  • StyleManager
  • Task
  • TextBuffer
  • ThemeManager

NotificationManager essential

A notification manager used to create Notifications to be shown to the user.

An instance of this class is always available as the atom.notifications global.

Events

::onDidAddNotification(callback)

Invoke the given callback after a notification has been added.

Argument Description
callback(notification)

Function to be called after the notification is added.

notification

The Notification that was added.

Return values

Returns a Disposable on which .dispose() can be called to unsubscribe.

Adding Notifications

::addSuccess(message, [options])

Add a success notification.

Argument Description
message

A String message

options optional

An options Object with the following keys:

.buttons optional

An Array of Object where each Object has the following options:

className optional

String a class name to add to the button's default class name (btn btn-success).

onDidClick() optional

Function callback to call when the button has been clicked. The context will be set to the NotificationElement instance.

text

String inner text for the button

.description optional

A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered.

.detail optional

A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered.

.dismissable optional

A Boolean indicating whether this notification can be dismissed by the user. Defaults to false.

.icon optional

A String name of an icon from Octicons to display in the notification header. Defaults to 'check'.

Return values

Returns the Notification that was added.

::addInfo(message, [options])

Add an informational notification.

Argument Description
message

A String message

options optional

An options Object with the following keys:

.buttons optional

An Array of Object where each Object has the following options:

className optional

String a class name to add to the button's default class name (btn btn-info).

onDidClick() optional

Function callback to call when the button has been clicked. The context will be set to the NotificationElement instance.

text

String inner text for the button

.description optional

A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered.

.detail optional

A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered.

.dismissable optional

A Boolean indicating whether this notification can be dismissed by the user. Defaults to false.

.icon optional

A String name of an icon from Octicons to display in the notification header. Defaults to 'info'.

Return values

Returns the Notification that was added.

::addWarning(message, [options])

Add a warning notification.

Argument Description
message

A String message

options optional

An options Object with the following keys:

.buttons optional

An Array of Object where each Object has the following options:

className optional

String a class name to add to the button's default class name (btn btn-warning).

onDidClick() optional

Function callback to call when the button has been clicked. The context will be set to the NotificationElement instance.

text

String inner text for the button

.description optional

A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered.

.detail optional

A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered.

.dismissable optional

A Boolean indicating whether this notification can be dismissed by the user. Defaults to false.

.icon optional

A String name of an icon from Octicons to display in the notification header. Defaults to 'alert'.

Return values

Returns the Notification that was added.

::addError(message, [options])

Add an error notification.

Argument Description
message

A String message

options optional

An options Object with the following keys:

.buttons optional

An Array of Object where each Object has the following options:

className optional

String a class name to add to the button's default class name (btn btn-error).

onDidClick() optional

Function callback to call when the button has been clicked. The context will be set to the NotificationElement instance.

text

String inner text for the button

.description optional

A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered.

.detail optional

A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered.

.dismissable optional

A Boolean indicating whether this notification can be dismissed by the user. Defaults to false.

.icon optional

A String name of an icon from Octicons to display in the notification header. Defaults to 'flame'.

.stack optional

A preformatted String with stack trace information describing the location of the error.

Return values

Returns the Notification that was added.

::addFatalError(message, [options])

Add a fatal error notification.

Argument Description
message

A String message

options optional

An options Object with the following keys:

.buttons optional

An Array of Object where each Object has the following options:

className optional

String a class name to add to the button's default class name (btn btn-error).

onDidClick() optional

Function callback to call when the button has been clicked. The context will be set to the NotificationElement instance.

text

String inner text for the button

.description optional

A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered.

.detail optional

A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered.

.dismissable optional

A Boolean indicating whether this notification can be dismissed by the user. Defaults to false.

.icon optional

A String name of an icon from Octicons to display in the notification header. Defaults to 'bug'.

.stack optional

A preformatted String with stack trace information describing the location of the error.

Return values

Returns the Notification that was added.

Getting Notifications

::getNotifications()

Get all the notifications.

Return values

Returns an Array of Notifications.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
with by