chrome_url_overrides

Type Object
Mandatory No
Manifest version 2 or higher
Example
json
  "chrome_url_overrides" : {
    "newtab": "my-new-tab.html"
  }

Use the chrome_url_overrides key to provide a custom replacement for the documents loaded into various special pages usually provided by the browser itself.

Syntax

The chrome_url_overrides key is an object that may have the following properties:

Name Type Description
bookmarks String

Provide a replacement for the page that shows the bookmarks.

history String

Provide a replacement for the page that shows the browsing history.

newtab String

Provide a replacement for the document that's shown in the "new tab" page. This is the page that's shown when the user has opened a new tab but has not loaded any document into it: for example, by using the Ctrl/Command+T keyboard shortcut.

The replacement is given as a URL to an HTML file. The file must be bundled with the extension: you can't specify a remote URL here. You can specify it relative to the extension's root folder, like: "path/to/newtab.html".

The document can load CSS and JavaScript, just like a normal web page. JavaScript running in the page gets access to the same privileged "browser.*" APIs as the extension's background script.

It's very good practice to include a <title> for the page, or the tab's title will be the "moz-extension://..." URL.

A common use case is to let the user define a new tab page: to do this, provide a custom new tab page that navigates to the page the user defined.

If two or more extensions both define custom new tab pages, then the last one to be installed or enabled gets to use its value.

To override the browser's homepage, use "chrome_settings_overrides" instead.

All properties are localizable.

Example

json
"chrome_url_overrides" : {
  "newtab": "my-new-tab.html"
}

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
chrome_url_overrides
Chrome – Full support
Chrome 58 (Release date: 2017-04-19)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – Full support
Firefox 54 (Release date: 2017-06-13)
footnote Full support
Opera – No support
Opera
footnote No support
Safari – Full support
Safari 15 (Release date: 2021-09-20)
altname
altname Alternate name: browser_url_overrides
Safari – Full support
Safari 14.1 (Release date: 2021-04-26)
footnote Full support
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – Full support
Safari on iOS 15 (Release date: 2021-09-20)
altname
altname Alternate name: browser_url_overrides
bookmarks
Chrome – Full support
Chrome 58 (Release date: 2017-04-19)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – No support
Firefox
footnote No support
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – No support
Safari on iOS
footnote No support
history
Chrome – Full support
Chrome 58 (Release date: 2017-04-19)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – No support
Firefox
footnote No support
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – No support
Safari on iOS
footnote No support
newtab
Chrome – Full support
Chrome 59 (Release date: 2017-06-05)
footnote
footnote If two or more extensions both define a custom new tab page, then in Firefox the first extension to run wins. In Chrome the last extension wins.
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote
footnote If two or more extensions both define a custom new tab page, then in Firefox the first extension to run wins. In Edge the last extension wins.
Firefox – Full support
Firefox 54 (Release date: 2017-06-13)
footnote
footnote If two or more extensions both define a custom new tab page, then in Firefox the first extension to run wins. In Chrome the last extension wins.
Opera – No support
Opera
footnote No support
Safari – Full support
Safari 14.1 (Release date: 2021-04-26)
footnote
footnote An extension can define a custom new tab or window page, but it does not take effect until the user chooses the extension to override the page in Safari's General settings.
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – Full support
Safari on iOS 15 (Release date: 2021-09-20)
footnote
footnote An extension can define a custom new tab or window page, but it does not take effect until the user chooses the extension to override the page in Safari's Extensions settings.

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.
Uses a non-standard name
Has more compatibility info.