browserSettings.overrideDocumentColors

A BrowserSetting object whose underlying value is a string.

Firefox enables the user to set their own colors for document backgrounds and text. By default these values are only applied when a high-contrast theme is selected (a high-contrast theme is a feature of some operating system UIs that increases the contrast for improved accessibility). However, users can also choose to apply these colors always or never. This browser setting exposes that preference.

Its underlying value is a string that may take any one of the following values:

  • "high-contrast-only": Apply the user's choices only when a high-contrast theme is selected. This is the default.
  • "never": Never apply the user's choices.
  • "always": Always apply the user's choices.

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
overrideDocumentColors
No
No
61
?
No
No
?
?
61
?
?
?

Examples

Set the setting to "always":

function logResult(result) {
  console.log(`Setting was modified: ${result}`);
}

browser.browserSettings.overrideDocumentColors.set({value: "always"}).
  then(logResult);

© 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/overrideDocumentColors