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.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
Notification
Web 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
.resistFingerprinting
is true, this setting has no effect and zoom is applied on a per-tab basis.
Browser compatibility
Desktop | Mobile | |||||
---|---|---|---|---|---|---|
allowPopupsForUserEvents | Chrome No support No | Edge No support No | Firefox Full support 57 | Opera No support No | Safari No support No | Firefox Android Full support 57 |
cacheEnabled | Chrome No support No | Edge No support No | Firefox Full support 56 | Opera No support No | Safari No support No | Firefox Android Full support 56 |
closeTabsByDoubleClick | Chrome No support No | Edge No support No | Firefox Full support 61 | Opera No support No | Safari No support No | Firefox Android No support No |
contextMenuShowEvent | Chrome No support No | Edge No support No | Firefox Full support 59 | Opera No support No | Safari No support No | Firefox Android Full support 59 |
ftpProtocolEnabled | Chrome No support No | Edge No support No | Firefox Full support 72 | Opera No support No | Safari No support No | Firefox Android No support No |
homepageOverride | Chrome No support No | Edge No support No | Firefox Full support 57 | Opera No support No | Safari No support No | Firefox Android Full support 57 |
imageAnimationBehavior | Chrome No support No | Edge No support No | Firefox Full support 57 | Opera No support No | Safari No support No | Firefox Android Full support 57 |
newTabPageOverride | Chrome No support No | Edge No support No | Firefox Full support 57 | Opera No support No | Safari No support No | Firefox Android Full support 57 |
newTabPosition | Chrome No support No | Edge No support No | Firefox Full support 61 | Opera No support No | Safari No support No | Firefox Android
Full support
61
|
openBookmarksInNewTabs | Chrome No support No | Edge No support No | Firefox Full support 59 | Opera No support No | Safari No support No | Firefox Android Full support 59 |
openSearchResultsInNewTabs | Chrome No support No | Edge No support No | Firefox Full support 59 | Opera No support No | Safari No support No | Firefox Android Full support 59 |
openUrlbarResultsInNewTabs | Chrome No support No | Edge No support No | Firefox Full support 61 | Opera No support No | Safari No support No | Firefox Android Full support 61 |
overrideDocumentColors | Chrome No support No | Edge No support No | Firefox Full support 61 | Opera No support No | Safari No support No | Firefox Android Full support 61 |
useDocumentFonts | Chrome No support No | Edge No support No | Firefox Full support 61 | Opera No support No | Safari No support No | Firefox Android Full support 61 |
webNotificationsDisabled | Chrome No support No | Edge No support No | Firefox Full support 58 | Opera No support No | Safari No support No | Firefox Android Full support 58 |
zoomFullPage | Chrome No support No | Edge No support No | Firefox Full support 75 | Opera No support No | Safari No support No | Firefox Android No support No |
zoomSiteSpecific | Chrome No support No | Edge No support No | Firefox Full support 75 | Opera No support No | Safari No support No | Firefox Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- See implementation notes.