Creating a Firefox sidebar

  • Revision slug: Creating_a_Firefox_sidebar
  • Revision title: Creating a Firefox sidebar
  • Revision id: 454651
  • Created:
  • Creator: Yoshino
  • Is current revision? No
  • Comment Removed an incorrect link, again

Revision Content

Web publishers can offer visitors a Firefox sidebar to encourage their engagement. There are two ways to create a sidebar for Firefox users: the Social API and an extension. You can choose either depending on your needs and resources.

The Social API

{{ Fx_minversion_section(17) }}

The Social API is a new API from Mozilla that allows social media services to integrate their content into the browser window. At this time, Facebook, Cliqz, mixi and MSN are partnering with Mozilla as social providers. Now the API is available to all Web developers so it's worth checking out if you are offering a social service.

An extension

An extension is a kind of add-ons that adds new functionalities to Firefox. There is a wide range of extensions available, and some of them provide a sidebar. Such kind of sidebar can be a simple Web panel or a full-featured extension that is completely integrated with the browser. You can find a sample extension to add a Web panel as a starter.

The window.sidebar API

{{ obsolete_header(23) }}

As of Firefox 23, the addPanel and addPersistentPanel functions have been removed from the deprecated, Netscape-derived {{ domxref("window.sidebar") }} object. That means the ability to add a traditional sidebar panel is no longer available from Web content. The new Social API or an extension can be used instead as described above.

Resources

Revision Source

<p>Web publishers can offer visitors a <strong>Firefox sidebar</strong> to encourage their engagement. There are two ways to create a sidebar for Firefox users: the Social API and an extension. You can choose either depending on your needs and resources.</p>
<h2 id="The_Social_API">The Social API</h2>
<p>{{ Fx_minversion_section(17) }}</p>
<p>The <a href="/en-US/docs/Social_API">Social API</a> is a new API from Mozilla that allows social media services to integrate their content into the browser window. At this time, <a href="https://blog.mozilla.org/blog/2012/12/03/firefox-gets-social-w-facebook/">Facebook</a>, <a href="https://blog.mozilla.org/blog/2013/05/14/stay-social-with-firefox/">Cliqz, mixi and MSN</a> are partnering with Mozilla as social providers. Now the <a href="https://blog.mozilla.org/futurereleases/2013/06/27/social-api-for-all/">API is available to all Web developers</a> so it's worth checking out if you are offering a social service.</p>
<h2 id="An_extension">An extension</h2>
<p>An <a href="/en-US/docs/Extensions">extension</a> is a kind of <a href="/en-US/docs/Mozilla/Add-ons">add-ons</a> that adds new functionalities to Firefox. There is a wide range of extensions available, and <a href="https://addons.mozilla.org/en-US/firefox/search/?q=sidebar">some of them provide a sidebar</a>. Such kind of sidebar can be a simple Web panel or a full-featured extension that is completely integrated with the browser. You can find a <a href="https://github.com/kyoshino/simple-sidebar">sample extension to add a Web panel</a> as a starter.</p>
<h2 id="The_window.sidebar_API">The <code>window.sidebar</code> API</h2>
<p>{{ obsolete_header(23) }}</p>
<p>As of <a href="/en-US/docs/Mozilla/Firefox/Releases/23">Firefox&nbsp;23</a>, the <code>addPanel</code> and <code>addPersistentPanel</code> functions have been removed from the deprecated, Netscape-derived {{ domxref("window.sidebar") }} object. That means the ability to add a traditional sidebar panel is no longer available from Web content. The new Social API or an extension can be used instead as described above.</p>
<h2 id="Resources">Resources</h2>
<ul>
  <li><a href="/en-US/docs/Social_API">Social API</a></li>
  <li><a href="/en-US/docs/Extensions">Extensions</a></li>
  <li><a href="/en-US/docs/Creating_a_Firefox_sidebar_extension">Creating a Firefox sidebar extension</a> – the original, obsolete document</li>
</ul>
Revert to this revision