Plugins

Plugins are shared libraries that users can install to display content that the application itself can't display natively. For example, the Adobe Reader plugin lets the user open PDF files directly inside the browser, and the QuickTime and RealPlayer plugins are used to play special format videos in a web page.

Plugins are now a legacy technology. They are not available on most mobile devices. Mozilla encourages website developers to avoid using plugins wherever possible. If there are plugin features which are not available in the web platform, we encourage developers to post their use cases to mozilla.dev.platform project list, so that Mozilla can prioritize web platform work to make those use cases possible.

Plugins are written using NPAPI, the cross-browser API for plugins. The main source of documentation for NPAPI is the Gecko Plugin API Reference. To make your plugin scriptable from web pages, use npruntime.

Plugins can be written completely from scratch using C APIs (usually in C or C++) or they may be built on a plugin framework such as Firebreath, JUCE, or QtBrowserPlugin. There are also some code generation tools that may be helpful. More information about these tools can be found on the External Resources page.

Plugins are different from extensions, which modify or enhance the functionality of the browser itself. Plugins are also different from search plugins, which plug additional search engines in the search bar.


Gecko Plugin API Reference (NPAPI)
This reference describes the application programming interfaces for NPAPI plugins and provides information about how to use these interfaces.
Site Author Guide For Click-To-Activate Plugins
These guidelines will help website authors use plugins when they are blocked by default with the Firefox click-to-activate feature.
Scripting plugins (npruntime)
This reference describes the new cross-browser NPAPI extensions that let plugins be scriptable and also let them access the script objects in the browser.
Shipping a plugin as a Toolkit bundle
Plugins can be shipped as a Toolkit bundle, allowing a user to easily install, uninstall and manage their personal plugins.
Detecting Plugins
How to use JavaScript to detect if a plugin is installed and suggestions on what to do if it is not.
Supporting private browsing in plugins
Firefox 3.5 introduced support for private browsing; learn how to make your plugin respect the user's privacy wishes.
Multi-Process Plugin Architecture
How Firefox loads plugins into a separate process. Firefox 3.6.4 introduced out-of-process plugins which execute in a separate process so that a crashing plugin does not crash the browser.
Logging and Debugging for Multi-Process Plugins
How to create a plugin log to aid in debugging problems with multi-process plugins.
Writing a plugin for Mac OS X
Learn how to write a plugin for Mac OS X; a template Xcode project is provided.
Monitoring Plugins
Use an observer service notification to monitor the amount of time spent executing calls in plugins. This can be useful when trying to determine if a plug-in is consuming too many resources.
Scripting Plugins: Macromedia Flash
This article explains how JavaScript can be used to access methods from within the Flash plugin, as well as how a feature called FSCommands can be used to access JavaScript functions from within the Flash animation.
Plugins: The First Install Problem
The First Install Problem is the name given to the conditions arising when a plugin or embeddable software installs itself on a system first, before any other Gecko-based browser.
Plugins: Samples and Test Cases
NPAPI plugin samples and test cases.
External Resources for Plugin Creation
External projects, frameworks, and blog posts that may be useful.
XEmbed Extension for Mozilla Plugins
Recent versions of Mozilla on *nix-based systems include an extension for writing plugins that use XEmbed instead of using the old Xt-based main loop that most plugins have been using since the Netscape 3.x days.

Categories

Interwiki Language Links

Join the plugin development community

Mailing list/newsgroup:
Choose your preferred method for joining the discussion.

Document Tags and Contributors

Last updated by: wbamberg,