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.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.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
allowPopupsForUserEventsChrome No support NoEdge No support NoFirefox Full support 57Opera No support NoFirefox Android Full support 57
cacheEnabledChrome No support NoEdge No support NoFirefox Full support 56Opera No support NoFirefox Android Full support 56
contextMenuShowEventChrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android Full support 59
homepageOverrideChrome No support NoEdge No support NoFirefox Full support 57Opera No support NoFirefox Android Full support 57
imageAnimationBehaviorChrome No support NoEdge No support NoFirefox Full support 57Opera No support NoFirefox Android Full support 57
newTabPageOverrideChrome No support NoEdge No support NoFirefox Full support 57Opera No support NoFirefox Android Full support 57
newTabPositionChrome No support NoEdge No support NoFirefox Full support 61Opera No support NoFirefox Android Full support 61
Notes
Full support 61
Notes
Notes This setting can be changed but has no effect.
openBookmarksInNewTabsChrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android Full support 59
openSearchResultsInNewTabsChrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android Full support 59
openUrlbarResultsInNewTabsChrome No support NoEdge No support NoFirefox Full support 61Opera No support NoFirefox Android Full support 61
overrideDocumentColorsChrome No support NoEdge No support NoFirefox Full support 61Opera No support NoFirefox Android Full support 61
useDocumentFontsChrome No support NoEdge No support NoFirefox Full support 61Opera No support NoFirefox Android Full support 61
webNotificationsDisabledChrome No support NoEdge No support NoFirefox Full support 58Opera No support NoFirefox Android Full support 58

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Document Tags and Contributors

Contributors to this page: wbamberg, l-hedgehog, Robbendebiene, hellosct1
Last updated by: wbamberg,