W3cubDocs

/Web Extensions

BrowserSetting

A BrowserSetting is an object representing a browser setting.

It provides methods to set and get the setting's underlying value, to clear any change you've made to it, and to listen for changes to its value.

Note that while this object is based on the ChromeSetting type, this object does not distinguish between setting the value in normal browsing windows and in private browsing windows. This means that all parts of the API relating to private browsing (such as the scope option to ChromeSetting.set()) are not implemented.

Methods

types.BrowserSetting.get()
Get the current value of the setting, and an enumeration representing how the setting is currently controlled.
types.BrowserSetting.set()
Set the setting to a new value.
types.BrowserSetting.clear()
Clear any change made to the setting by this extension.

Events

types.BrowserSetting.onChange
Fired when the setting's value changes.

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
BrowserSetting
Yes
79
54
?
Yes
No
?
?
54
?
?
?
onChange
Yes
79
72
?
Yes
No
?
?
No
?
?
?

Note: This API is based on Chromium's chrome.types API.

© 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/types/BrowserSetting