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
topSitesManifest
You must declare the "topSites" permission in your extension's manifest to use this API.
{
"name": "My extension",
...
"permissions": [
"topSites",
],
...
}
Examples
To try this API, install the topSites API example from the chrome-extension-samples repository.
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,
)
Gets a list of top sites.
Parameters
-
callback
function optional
The
callbackparameter looks like:(data: MostVisitedURL[]) => void
-
data
-
Returns
-
Promise<MostVisitedURL[]>
Chrome 96+Promises are only supported for Manifest V3 and later, other platforms need to use callbacks.