欢迎 What's new in Chrome extensions Get help with Chrome extensions API reference Samples
欢迎 What's new in Chrome extensions Get help with Chrome extensions API reference Samples

chrome.topSites

  • Description

    Use the chrome.topSites API to access the top sites (i.e. most visited sites) that are displayed on the new tab page. These do not include shortcuts customized by the user.

  • Permissions
    topSites
    This permission triggers a warning.

Manifest

You must declare the "topSites" permission in your extension's manifest to use this API.

{
"name": "My extension",
...
"permissions": [
"topSites",
],
...
}

Examples

You can find samples of this API in Samples.

Summary

Types

MostVisitedURL

An object encapsulating a most visited URL, such as the default shortcuts on the new tab page.

Properties

  • title

    string

    The title of the page

  • url

    string

    The most visited URL.

Methods

get

chrome.topSites.get(
  callback?: function,
)
Promise

Gets a list of top sites.

Parameters

Returns

  • Promise<MostVisitedURL[]>

    Chrome 96+

    Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.

We serve cookies on this site to analyze traffic, remember your preferences, and optimize your experience.