Your Search Results

    Tabbed Browser

    Here you should find a set of useful code snippets to help you work with Firefox's tabbed browser. The comments normally mark where you should be inserting your own code.

    Each snippet normally includes some code to run at initialization, these are best run using a load listener. These snippets assume they are run in the context of a browser window. If you need to work with tabs from a non-browser window, you need to obtain a reference to one first, see Working with windows in chrome code for details.

    Multiple meanings for the word 'browser'

    The word 'browser' is used several ways. Of course the entire application Firefox is called "a browser". Within the Firefox browser are tabs and inside each tab is a browser, both in the common sense of a web page browser and the XUL sense of a browser element. Furthermore another meaning of 'browser' in this document and in some Firefox source is "the tabbrowser element" in a Firefox XUL window.

    Getting access to the browser

    From main window

    Code running in Firefox's global ChromeWindow, common for extensions that overlay into browser.xul, can access the tabbrowser element using the global variable gBrowser.

    // gBrowser is only accessible from the scope of 
    // the browser window (browser.xul)
    gBrowser.addTab(...);
    

    If gBrowser isn't defined your code is either not running in the scope of the browser window or running too early. You can access gBrowser only after the browser window is fully loaded. If you need to do something with gBrowser right after the window is opened, listen for the load event and use gBrowser in the event listener.

    If your code does not have access to the main window because it is run in a sidebar or dialog, you first need to get access to the browser window you need before you can use gBrowser. You can find more information on getting access to the browser window in Working with windows in chrome code.

    From a sidebar

    Basically, if your extension code is a sidebar you can use:

    var mainWindow = window.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
                           .getInterface(Components.interfaces.nsIWebNavigation)
                           .QueryInterface(Components.interfaces.nsIDocShellTreeItem)
                           .rootTreeItem
                           .QueryInterface(Components.interfaces.nsIInterfaceRequestor)
                           .getInterface(Components.interfaces.nsIDOMWindow);
    
    mainWindow.gBrowser.addTab(...);
    

    From a dialog

    If your code is running in a dialog opened directly by a browser window, you can use:

    window.opener.gBrowser.addTab(...);
    

    If window.opener doesn't work, you can get the most recent browser window using this code:

    var wm = Components.classes["@mozilla.org/appshell/window-mediator;1"]
                       .getService(Components.interfaces.nsIWindowMediator);
    var mainWindow = wm.getMostRecentWindow("navigator:browser");
    mainWindow.gBrowser.addTab(...);
    

    Opening a URL in a new tab

    // Add tab  
    gBrowser.addTab("http://www.google.com/");
    
    // Add tab, then make active
    gBrowser.selectedTab = gBrowser.addTab("http://www.google.com/");
    

    Manipulating content of a new tab

    If you want to work on the content of the newly opened tab, you'll need to wait until the content has finished loading.

    // WRONG WAY (the page hasn't finished loading yet)
    var newTabBrowser = gBrowser.getBrowserForTab(gBrowser.addTab("http://www.google.com/"));
    alert(newTabBrowser.contentDocument.body.innerHTML);
    
    // BETTER WAY
    var newTabBrowser = gBrowser.getBrowserForTab(gBrowser.addTab("http://www.google.com/"));
    newTabBrowser.addEventListener("load", function () {
      newTabBrowser.contentDocument.body.innerHTML = "<div>hello world</div>";
    }, true);
    

    (The event target in the onLoad handler will be a 'tab' XUL element). See tabbrowser for getBrowserForTab()

    Opening a URL in the correct window/tab

    There are methods available in chrome://browser/content/utilityOverlay.js that make it easy to open URL in tabs such as openUILinkIn and openUILink.

    openUILinkIn( url, where, allowThirdPartyFixup, postData, referrerUrl )
    where:
    • "current" current tab (if there aren't any browser windows, then in a new window instead)
    • "tab" new tab (if there aren't any browser windows, then in a new window instead)
    • "tabshifted" same as "tab" but in background if default is to select new tabs, and vice versa
    • "window" new window
    • "save" save to disk (with no filename hint!)
    openUILink( url, e, ignoreButton, ignoreAlt, allowKeywordFixup, postData, referrerUrl )
     

    The following code will open a URL in a new tab, an existing tab, or an existing window based on which mouse button was pressed and which hotkeys (ex: Ctrl) are being held. The code given is for a menuitem, but will work equally well for other XUL elements. This will only work in an overlay of browser.xul.

    XUL:

    <menuitem oncommand="myExtension.foo(event)" onclick="checkForMiddleClick(this, event)" label="Click me"/>
    

    JS:

    var myExtension = {
      foo: function(event) {
        openUILink("http://www.example.com", event, false, true);
      }
    }

    Opening a URL in an on demand tab

    var gSessionStore = Cc["@mozilla.org/browser/sessionstore;1"].getService(Ci.nsISessionStore);
    
    // Create new tab, but don't load the content.
    var url = "https://developer.mozilla.org";
    var tab = gBrowser.addTab(null);
    gSessionStore.setTabState(tab,
      '{\
        "entries":[\
          {\
            "url":"' + url + '",\
            "title":"' + url + '"\
          }\
        ],\
        "lastAccessed":0,\
        "index":1,\
        "hidden":false,\
        "attributes":{},\
        "image":null\
      }'
    );
    

    Reusing tabs

    Rather than open a new browser or new tab each and every time one is needed, it is good practice to try to re-use an existing tab which already displays the desired URL--if one is already open. Following this practice minimizes the proliferation of tabs and browsers created by your extension.

    Reusing by URL/URI

    A common feature found in many extensions is to point the user to chrome:// URIs in a browser window (for example, help or about information) or external (on-line http(s)://) HTML documents when the user clicks an extension's button or link. The following code demonstrates how to re-use an existing tab that already displays the desired URL/URI. If no such tab exists, a new one is opened with the specified URL/URI.

    function openAndReuseOneTabPerURL(url) {
      var wm = Components.classes["@mozilla.org/appshell/window-mediator;1"]
                         .getService(Components.interfaces.nsIWindowMediator);
      var browserEnumerator = wm.getEnumerator("navigator:browser");
    
      // Check each browser instance for our URL
      var found = false;
      while (!found && browserEnumerator.hasMoreElements()) {
        var browserWin = browserEnumerator.getNext();
        var tabbrowser = browserWin.gBrowser;
    
        // Check each tab of this browser instance
        var numTabs = tabbrowser.browsers.length;
        for (var index = 0; index < numTabs; index++) {
          var currentBrowser = tabbrowser.getBrowserAtIndex(index);
          if (url == currentBrowser.currentURI.spec) {
    
            // The URL is already opened. Select this tab.
            tabbrowser.selectedTab = tabbrowser.tabContainer.childNodes[index];
    
            // Focus *this* browser-window
            browserWin.focus();
    
            found = true;
            break;
          }
        }
      }
    
      // Our URL isn't open. Open it now.
      if (!found) {
        var recentWindow = wm.getMostRecentWindow("navigator:browser");
        if (recentWindow) {
          // Use an existing browser window
          recentWindow.delayedOpenTab(url, null, null, null, null);
        }
        else {
          // No browser windows are open, so open a new one.
          window.open(url);
        }
      }
    }
    
    Reusing by other criteria

    Sometimes you want to reuse a previously-opened tab regardless of which URL/URI it displays. This assumes the tab is opened by your extension, not by some other browser component. We can do re-use an arbitrary tab by attaching a custom attribute to it when we first open it. Later, when we want to re-use that tab, we iterate over all open tabs looking for one which has our custom attribute. If such a tab exists, we change its URL/URI and focus/select it. If no such tab exists (perhaps the user closed it or we never opened it in the first place), we create a new tab with our custom attribute.

    function openAndReuseOneTabPerAttribute(attrName, url) {
      var wm = Components.classes["@mozilla.org/appshell/window-mediator;1"]
                         .getService(Components.interfaces.nsIWindowMediator);
      for (var found = false, index = 0, tabbrowser = wm.getEnumerator('navigator:browser').getNext().gBrowser;
           index < tabbrowser.tabContainer.childNodes.length && !found;
           index++) {
    
        // Get the next tab
        var currentTab = tabbrowser.tabContainer.childNodes[index];
      
        // Does this tab contain our custom attribute?
        if (currentTab.hasAttribute(attrName)) {
    
          // Yes--select and focus it.
          tabbrowser.selectedTab = currentTab;
    
          // Focus *this* browser window in case another one is currently focused
          tabbrowser.ownerDocument.defaultView.focus();
          found = true;
        }
      }
    
      if (!found) {
        // Our tab isn't open. Open it now.
        var browserEnumerator = wm.getEnumerator("navigator:browser");
        var tabbrowser = browserEnumerator.getNext().gBrowser;
      
        // Create tab
        var newTab = tabbrowser.addTab(url);
        newTab.setAttribute(attrName, "xyz");
      
        // Focus tab
        tabbrowser.selectedTab = newTab;
        
        // Focus *this* browser window in case another one is currently focused
        tabbrowser.ownerDocument.defaultView.focus();
      }
    }
    

    The function can be called like so:

    openAndReuseOneTabPerAttribute("myextension-myattribute", "http://developer.mozilla.org/").
    

    Closing a tab

    This example closes the currently selected tab.

    gBrowser.removeCurrentTab();
    

    There is also a more generic removeTab method, which accepts a XUL tab element as its single parameter.

    Changing active tab

    This moves one tab forward (to the right).

    gBrowser.tabContainer.advanceSelectedTab(1, true);
    

    This moves one tab to the left.

    gBrowser.tabContainer.advanceSelectedTab(-1, true);
    

    Detecting page load

    See also Code snippets:On page load

    function examplePageLoad(event) {
      if (event.originalTarget instanceof HTMLDocument) {
        var win = event.originalTarget.defaultView;
        if (win.frameElement) {
          // Frame within a tab was loaded. win should be the top window of
          // the frameset. If you don't want do anything when frames/iframes
          // are loaded in this web page, uncomment the following line:
          // return;
          // Find the root document:
          win = win.top;
        }
      }
    }
    
    // do not try to add a callback until the browser window has
    // been initialised. We add a callback to the tabbed browser
    // when the browser's window gets loaded.
    window.addEventListener("load", function () {
      // Add a callback to be run every time a document loads.
      // note that this includes frames/iframes within the document
      gBrowser.addEventListener("load", examplePageLoad, true);
    }, false);
    
    ...
    // When no longer needed
    gBrowser.removeEventListener("load", examplePageLoad, true);
    ...
    

    Notification when a tab is added or removed

    function exampleTabAdded(event) {
      var browser = gBrowser.getBrowserForTab(event.target);
      // browser is the XUL element of the browser that's been added
    }
    
    function exampleTabMoved(event) {
      var browser = gBrowser.getBrowserForTab(event.target);
      // browser is the XUL element of the browser that's been moved
    }
    
    function exampleTabRemoved(event) {
      var browser = gBrowser.getBrowserForTab(event.target);
      // browser is the XUL element of the browser that's been removed
    }
    
    // During initialization
    var container = gBrowser.tabContainer;
    container.addEventListener("TabOpen", exampleTabAdded, false);
    container.addEventListener("TabMove", exampleTabMoved, false);
    container.addEventListener("TabClose", exampleTabRemoved, false);
    
    // When no longer needed
    container.removeEventListener("TabOpen", exampleTabAdded, false);
    container.removeEventListener("TabMove", exampleTabMoved, false);
    container.removeEventListener("TabClose", exampleTabRemoved, false);
    

    Gecko 1.9.1 note
    (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)

    Starting in Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0), there's an easy way to listen on progress events on all tabs.

    (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

    Notification when a tab's attributes change

    Starting in Gecko 2.0, you can detect when a tab's attributes change by listening for the TabAttrModified event. The attributes to which changes result in this event being sent are:

    function exampleTabAttrModified(event) {
      var tab = event.target;
      // Now you can check what's changed on the tab
    }
    
    // During initialization
    var container = gBrowser.tabContainer;
    container.addEventListener("TabAttrModified", exampleTabAttrModified, false);
    
    // When no longer needed
    container.removeEventListener("TabAttrModified", exampleTabAttrModified, false);
    

    (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

    Notification when a tab is pinned or unpinned

    Starting in Gecko 2.0, tabs can be "pinned"; that is, they become special application tabs ("app tabs"), which are pinned to the beginning of the tab bar, and show only the favicon. You can detect when a tab becomes pinned or unpinned by watching for the TabPinned and TabUnpinned events.

    function exampleTabPinned(event) {
      var browser = gBrowser.getBrowserForTab(event.target);
      // browser is the XUL element of the browser that's been pinned
    }
    
    function exampleTabUnpinned(event) {
      var browser = gBrowser.getBrowserForTab(event.target);
      // browser is the XUL element of the browser that's been pinned
    }
    
    // Initialization
    
    var container = gBrowser.tabContainer;
    container.addEventListener("TabPinned", exampleTabPinned, false);
    container.addEventListener("TabUnpinned", exampleTabUnpinned, false);
    
    // When no longer needed
    
    container.removeEventListener("TabPinned", exampleTabPinned, false);
    container.removeEventListener("TabUnpinned", exampleTabUnpinned, false);
    

    Detecting tab selection

    The following code allows you to detect when a new tab is selected in the browser:

    function exampleTabSelected(event) {
      var browser = gBrowser.selectedBrowser;
      // browser is the XUL element of the browser that's just been selected
    }
    
    // During initialisation
    var container = gBrowser.tabContainer;
    container.addEventListener("TabSelect", exampleTabSelected, false);
    
    // When no longer needed
    container.removeEventListener("TabSelect", exampleTabSelected, false);
    

    Getting document of currently selected tab

    The following code allows you to retrieve the document that is in the selected tab. This code will work in the scope of the browser window (e.g. you're working from an overlay to the browser window).

    gBrowser.contentDocument;
    

    or

    content.document
    

    If you're working from a window or dialog that was opened by the browser window, you can use this code to get the document displayed in the selected tab in the browser window that opened the new window or dialog.

    window.opener.content.document
    

    From windows or dialogs not opened by the browser window, you can use nsIWindowMediator to get the document displayed in the selected tab of the most recently used browser window.

    var wm = Components.classes["@mozilla.org/appshell/window-mediator;1"]
                       .getService(Components.interfaces.nsIWindowMediator);
    var recentWindow = wm.getMostRecentWindow("navigator:browser");
    return recentWindow ? recentWindow.content.document.location : null;
    

    See also Working with windows in chrome code.

    Enumerating browsers

    To go through all browser in a tabbrowser, first get a reference to a browser's window. If your code is executed from a Firefox browser.xul overlay (for example, it is a toolbar button or menu click handler), you can access the current window with the window pre-defined variable. However, if your code is executed from its own window (for example, a settings/options dialog), you can use nsIWindowMediator to get a browser's window.

    Next, get the <tabbrowser/> element. You can get it with win.gBrowser, where win is the browser's window from the previous step. You can use simply gBrowser instead of window.gBrowser if running in the context of a browser.xul overlay.

    Finally, use gBrowser.browsers.length to get the number of browsers and gBrowser.getBrowserAtIndex() to get a <browser/> element. For example:

    var num = gBrowser.browsers.length;
    for (var i = 0; i < num; i++) {
      var b = gBrowser.getBrowserAtIndex(i);
      try {
        dump(b.currentURI.spec); // dump URLs of all open tabs to console
      } catch(e) {
        Components.utils.reportError(e);
      }
    }

    To learn what methods are available for <browser/> and <tabbrowser/> elements, use DOM Inspector or look in browser.xml for corresponding XBL bindings (or just look at the current reference pages on browser and tabbrowser.

    Getting the browser that fires the http-on-modify-request notification

    See the Observer notifications page for information on http-on-* notifications.

    Note that some HTTP requests aren't associated with a tab; for example, RSS feed updates, extension manager requests, XHR requests from XPCOM components, etc. In those cases, the following code returns null.

    Warning: This code should be updated to use nsILoadContext instead of getInterface(Components.interfaces.nsIDOMWindow), see this example.
    observe: function (subject, topic, data) {
      if (topic == "http-on-modify-request") {
        subject.QueryInterface(Components.interfaces.nsIHttpChannel);
        var url = subject.URI.spec; /* url being requested. you might want this for something else */
        var browser = this.getBrowserFromChannel(subject);
        if (browser != null) {
          /* do something */
        }
      }
    },
    
    getBrowserFromChannel: function (aChannel) {
      try {
        var notificationCallbacks = 
          aChannel.notificationCallbacks ? aChannel.notificationCallbacks : aChannel.loadGroup.notificationCallbacks;
    
        if (!notificationCallbacks)
          return null;
    
        var domWin = notificationCallbacks.getInterface(Components.interfaces.nsIDOMWindow);
        return gBrowser.getBrowserForDocument(domWin.top.document);
      }
      catch (e) {
        dump(e + "\n");
        return null;
      }
    }
    

    Document Tags and Contributors

    Contributors to this page: Nickolay
    Last updated by: Nickolay,