The notifications module allows you to display transient, toaster-style desktop messages to the user.

This API supports desktop notifications on Windows, OS X using Growl, and Linux using libnotify. If the user's system does not support desktop notifications or if its notifications service is not running, then notifications made with this API are logged to Firefox's error console and, if the user launched Firefox from the command line, the terminal.

Examples

Here's a typical example. When the message is clicked, a string is logged to the console.

var notifications = require("notifications");
notifications.notify({
  title: "Jabberwocky",
  text: "'Twas brillig, and the slithy toves",
  data: "did gyre and gimble in the wabe",
  onClick: function (data) {
    console.log(data);
    // console.log(this.data) would produce the same result.
  }
});

This one displays an icon that's stored in the add-on's data directory. (See the self module documentation for more information.)

var notifications = require("notifications");
var self = require("self");
var myIconURL = self.data.url("myIcon.png");
notifications.notify({
  text: "I have an icon!",
  iconURL: myIconURL
});