Back to Content

browserSettings.newTabPageOverride

files/en-us/mozilla/add-ons/webextensions/api/browsersettings/newtabpageoverride/index.md

latest482 B
Original Source

A {{WebExtAPIRef("types.BrowserSetting", "BrowserSetting")}} object that can be used to get a string representing the URL for the "new tab" page: that is, the page that's loaded when the user opens a new empty tab.

Note that this is a read-only setting.

Examples

Get the current value of the new tab URL:

js
browser.browserSettings.newTabPageOverride.get({}).then((result) => {
  console.log(result.value);
});

{{WebExtExamples}}

Browser compatibility

{{Compat}}