topSites.get()

Syntax

let gettingTopSites = browser.topSites.get(
    options  // object
)

Parameters

options

object. Options to modify the list of pages returned. This may include any of the following properties:

includeBlocked Optional

Boolean. Include pages that the user has removed from the "New Tab" page. Defaults to false.

includeFavicon Optional

Boolean. Include favicons in the results, for pages where they are available. Defaults to false.

includePinned Optional

Boolean. Includes sites that the user has pinned to the Firefox new tab. Defaults to false.

includeSearchShortcuts Optional

Boolean. Includes search shortcuts that appear on the Firefox new tab. Defaults to false.

limit Optional

Integer. The number of pages to return. This must be a number between 1 and 100, inclusive. Defaults to 12.

newtab Optional

Boolean. If included, the method returns the list of pages returned when the user opens a new tab. If included, and set to true, the method ignores all other parameters except limit and includeFavicon. Defaults to false.

onePerDomain Optional

Boolean. Only include one page per domain. Defaults to true.

Return value

A Promise. This will be fulfilled with an array of MostVisitedURL objects, one for each page listed in the browser's "New Tab" page. If an error occurs, the promise will be rejected with an error message.

Examples

This code logs the title and URL for all pages in the "New Tab" page:

function logTopSites(topSitesArray) {
  for (const topSite of topSitesArray) {
    console.log(`Title: ${topSite.title}, URL: ${topSite.url}`);
  }
}

function onError(error) {
  console.error(error);
}

browser.topSites.get().then(logTopSites, onError);

This code logs the title and URL for all top pages, including ones the user has blocked, and potentially including multiple pages in the same domain:

function logTopSites(topSitesArray) {
  for (const topSite of topSitesArray) {
    console.log(`Title: ${topSite.title}, URL: ${topSite.url}`);
  }
}

function onError(error) {
  console.error(error);
}

browser.topSites
  .get({
    includeBlocked: true,
    onePerDomain: false,
  })
  .then(logTopSites, onError);

Example extensions

• top-sites

Browser compatibility