browserSettings
Enables an extension to modify certain global browser settings. Each property of this API is a BrowserSetting object, providing the ability to modify a particular setting.
Because these are global settings, it's possible for extensions to conflict. See the documentation for BrowserSetting.set() for details of how conflicts are handled.
To use this API you need to have the "browserSettings" permission.
Properties
browserSettings.allowPopupsForUserEvents- Determines whether code running in web pages can display popups in response to user events.
browserSettings.cacheEnabled- Determines whether the browser cache is enabled or not.
browserSettings.closeTabsByDoubleClick- Determines whether the selected tab can be closed with a double click.
browserSettings.colorManagement- Determines various settings for color management.
browserSettings.contextMenuShowEvent- Determines the mouse event that triggers a context menu popup.
browserSettings.ftpProtocolEnabled- Determines whether the FTP protocol is enabled.
browserSettings.homepageOverride- Read the value of the browser's home page.
browserSettings.imageAnimationBehavior- Determines how the browser treats animated images.
browserSettings.newTabPageOverride- Reads the value of the browser's new tab page.
browserSettings.newTabPosition- Controls the position of newly opened tabs relative to already open tabs.
browserSettings.openBookmarksInNewTabs- Determines whether bookmarks are opened in the current tab or a new tab.
browserSettings.openSearchResultsInNewTabs- Determines whether search results are opened in the current tab or a new tab.
browserSettings.openUrlbarResultsInNewTabs- Determines whether address bar autocomplete suggestions are opened in the current tab or a new tab.
browserSettings.overrideDocumentColors- Controls whether the user-chosen colors override the page's colors.
browserSettings.useDocumentFonts- Controls whether the browser will use the fonts specified by a web page or use only built-in fonts.
browserSettings.webNotificationsDisabled- Prevents websites from showing notifications using the
NotificationWeb API. browserSettings.zoomFullPage- Controls whether zoom is applied to the entire page or to text only.
browserSettings.zoomSiteSpecific- Controls whether page zoom is applied on a per-site or per-tab basis. If
privacy.websites.resistFingerprintingis true, this setting has no effect and zoom is applied on a per-tab basis.
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
allowPopupsForUserEvents |
No |
No |
57 |
? |
No |
No |
? |
? |
57 |
? |
? |
? |
cacheEnabled |
No |
No |
56 |
? |
No |
No |
? |
? |
56 |
? |
? |
? |
closeTabsByDoubleClick |
No |
No |
61 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
colorManagement |
No |
No |
91 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
contextMenuShowEvent |
No |
No |
59 |
? |
No |
No |
? |
? |
59 |
? |
? |
? |
ftpProtocolEnabled |
No |
No |
72
From version 88, this setting is read-only (see bug 1626365).
|
? |
No |
No |
? |
? |
No |
? |
? |
? |
homepageOverride |
No |
No |
57 |
? |
No |
No |
? |
? |
57 |
? |
? |
? |
imageAnimationBehavior |
No |
No |
57 |
? |
No |
No |
? |
? |
57 |
? |
? |
? |
newTabPageOverride |
No |
No |
57 |
? |
No |
No |
? |
? |
57 |
? |
? |
? |
newTabPosition |
No |
No |
61 |
? |
No |
No |
? |
? |
61
This setting can be changed but has no effect.
|
? |
? |
? |
openBookmarksInNewTabs |
No |
No |
59 |
? |
No |
No |
? |
? |
59 |
? |
? |
? |
openSearchResultsInNewTabs |
No |
No |
59 |
? |
No |
No |
? |
? |
59 |
? |
? |
? |
openUrlbarResultsInNewTabs |
No |
No |
61 |
? |
No |
No |
? |
? |
61 |
? |
? |
? |
overrideDocumentColors |
No |
No |
61 |
? |
No |
No |
? |
? |
61 |
? |
? |
? |
useDocumentFonts |
No |
No |
61 |
? |
No |
No |
? |
? |
61 |
? |
? |
? |
webNotificationsDisabled |
No |
No |
58 |
? |
No |
No |
? |
? |
58 |
? |
? |
? |
zoomFullPage |
No |
No |
75 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
zoomSiteSpecific |
No |
No |
75 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserSettings