MDN wants to talk to developers like you: https://qsurvey.mozilla.com/s3/8d22564490d8

User interface

WebExtensions are provided with several user interface options so that their functionality can be made available to the user. A summary of those options is provided below, with a more detailed introduction to each user interface option in this section.

UI option Description Example
Browser toolbar button A button on the browser toolbar that dispatches an event to the add-on when clicked. By default, the button is visible in all tabs. Example of a WebExtension toolbar button
Browser toolbar button with a popup A popup on a button in the browser toolbar that opens when the button is clicked. The popup is defined in an HTML document that handles the user interaction. Example of a WebExtension toolbar button with a popup
Address bar button A button on the browser address bar that dispatches an event to the add-on when clicked. By default, the button is hidden in all tabs. Example showing an address bar button (page action)
Address bar button with a popup A popup on a button in the browser address bar that opens when the button is clicked. The popup is defined in an HTML document that handles the user interaction. Example of a popup on the address bar button
Context menu items Menu items, checkboxes, and radio buttons on one or more of the browser's context menus. Also, menus can be structured by adding separators. When menu items are clicked, an event is dispatched to the add-on.
Sidebar

An HTML document displayed next to a web page, with the option for unique content per page. The sidebar is opened when the add-on is installed, then obeys the user's sidebar visibility selection. User interaction within the sidebar is handled by its HTML document.

Example of a WebExtension's sidebar
Options page A page that enables you to define preferences for your WebExtension that your users can change. The user can access this page in the from the browser's add-ons manager. Example showing the options page content added in the favorite colors example.
Bundled web pages Use web pages included in your WebExtension to provide forms, help, or any other content required, within windows or tabs. Example of a simple bundled page displayed as a detached panel.
Notifications Transient notifications displayed to the user through the underlying operating system's notifications mechanism. Dispatches an event to the add-on when the user clicks a notification, or when a notification closes (either automatically or at the user's request). Example notification from a WebExtension
Address bar suggestions Offer custom address bar suggestions when the user enters a keyword. Example showing the result of the firefox_code_search WebExtension's customization of the address bar suggestions.
Developer tools panels A tab with an associated HTML document that displays in the browser's developer tools. New panel tab in the Developer Tools tab bar

The following how-to guides provide step-by-step guidance to creating some of these user interface options:

Document Tags and Contributors

 Contributors to this page: rebloor, wbamberg
 Last updated by: rebloor,