Add-ons

toast

Add-ons using the techniques described in this document are considered a legacy technology in Firefox. Don't use these techniques to develop new add-ons. Use WebExtensions instead. If you maintain an add-on which uses the techniques described here, consider migrating it to use WebExtensions.

Starting from Firefox 53, no new legacy add-ons will be accepted on addons.mozilla.org (AMO) for desktop Firefox and Firefox for Android.

Starting from Firefox 57, only extensions developed using WebExtensions APIs will be supported on Desktop Firefox and Firefox for Android.

Even before Firefox 57, changes coming up in the Firefox platform will break many legacy extensions. These changes include multiprocess Firefox (e10s), sandboxing, and multiple content processes. Legacy extensions that are affected by these changes should migrate to use WebExtensions APIs if they can. See the "Compatibility Milestones" document for more information.

A wiki page containing resources, migration paths, office hours, and more, is available to help developers transition to the new technologies.

The NativeWindow object is only available to privileged code running on Firefox for Android, and is intended for use by Firefox for Android add-ons.

NativeWindow.toast will be deprecated in Firefox 45.

New code should use Snackbars.jsm to display notifications. To maintain backward compatibility NativeWindow.toast will still work, by delegating calls to Snackbars.jsm.

Summary

Returns a reference to the NativeWindow.toast object, which can be used to display toast notifications on Firefox for Android.

A toast notification is a message that appears on the screen for a set interval and then fades away. It does not accept user input.

You can display a toast using NativeWindow.toast.show(), supplying:

  • the message to display
  • a duration parameter that controls how long the toast should be displayed. This takes one of two values: short or long.

Example

In the example below, an add-on adds a menu item that displays a toast:

function showToast(window) {  
  window.NativeWindow.toast.show("Showing you a toast", "short");  
}  
      
var menuID;  
      
function addMenuItem(window) {  
  menuID = window.NativeWindow.menu.add("Show Toast", null, function(){  
    showToast(window);   
  });  
}

Methods

show
Show a toast notification.

See also

Document Tags and Contributors

 Contributors to this page: rebloor, andrewtruongmoz, wbamberg, dkocho4, alex_johnson, justinpotts
 Last updated by: rebloor,