Bug 1957495 - Move ToolbarIconColor helper object from browser.js into its own module browser/themes/ToolbarIconColor.sys.mjs r=Gijs,desktop-theme-reviewers,emilio

Differential Revision: https://phabricator.services.mozilla.com/D244058
This commit is contained in:
shaneziegler
2025-04-14 16:46:02 +00:00
parent c8692210c5
commit 9e82afc772
4 changed files with 145 additions and 116 deletions

View File

@@ -134,7 +134,7 @@ var gBrowserInit = {
// Call this after we set attributes that might change toolbars' computed
// text color.
ToolbarIconColor.init();
ToolbarIconColor.init(window);
},
onDOMContentLoaded() {
@@ -1000,7 +1000,7 @@ var gBrowserInit = {
CustomTitlebar.uninit();
ToolbarIconColor.uninit();
ToolbarIconColor.uninit(window);
// In certain scenarios it's possible for unload to be fired before onload,
// (e.g. if the window is being closed after browser.js loads but before the

View File

@@ -92,6 +92,7 @@ ChromeUtils.defineESModuleGetters(this, {
TelemetryEnvironment: "resource://gre/modules/TelemetryEnvironment.sys.mjs",
ToolbarContextMenu: "resource:///modules/ToolbarContextMenu.sys.mjs",
ToolbarDropHandler: "resource:///modules/ToolbarDropHandler.sys.mjs",
ToolbarIconColor: "moz-src:///browser/themes/ToolbarIconColor.sys.mjs",
TranslationsParent: "resource://gre/actors/TranslationsParent.sys.mjs",
UITour: "moz-src:///browser/components/uitour/UITour.sys.mjs",
UpdateUtils: "resource://gre/modules/UpdateUtils.sys.mjs",
@@ -5124,120 +5125,6 @@ var MousePosTracker = {
},
};
var ToolbarIconColor = {
_windowState: {
active: false,
fullscreen: false,
customtitlebar: false,
},
init() {
this._initialized = true;
window.addEventListener("nativethemechange", this);
window.addEventListener("activate", this);
window.addEventListener("deactivate", this);
window.addEventListener("toolbarvisibilitychange", this);
window.addEventListener("windowlwthemeupdate", this);
// If the window isn't active now, we assume that it has never been active
// before and will soon become active such that inferFromText will be
// called from the initial activate event.
if (Services.focus.activeWindow == window) {
this.inferFromText("activate");
}
},
uninit() {
this._initialized = false;
window.removeEventListener("nativethemechange", this);
window.removeEventListener("activate", this);
window.removeEventListener("deactivate", this);
window.removeEventListener("toolbarvisibilitychange", this);
window.removeEventListener("windowlwthemeupdate", this);
},
handleEvent(event) {
switch (event.type) {
case "activate":
case "deactivate":
case "nativethemechange":
case "windowlwthemeupdate":
this.inferFromText(event.type);
break;
case "toolbarvisibilitychange":
this.inferFromText(event.type, event.visible);
break;
}
},
// a cache of luminance values for each toolbar
// to avoid unnecessary calls to getComputedStyle
_toolbarLuminanceCache: new Map(),
inferFromText(reason, reasonValue) {
if (!this._initialized) {
return;
}
switch (reason) {
case "activate": // falls through
case "deactivate":
this._windowState.active = reason === "activate";
break;
case "fullscreen":
this._windowState.fullscreen = reasonValue;
break;
case "nativethemechange":
case "windowlwthemeupdate":
// theme change, we'll need to recalculate all color values
this._toolbarLuminanceCache.clear();
break;
case "toolbarvisibilitychange":
// toolbar changes dont require reset of the cached color values
break;
case "customtitlebar":
this._windowState.customtitlebar = reasonValue;
break;
}
let toolbarSelector = ".browser-toolbar:not([collapsed=true])";
if (AppConstants.platform == "macosx") {
toolbarSelector += ":not([type=menubar])";
}
// The getComputedStyle calls and setting the brighttext are separated in
// two loops to avoid flushing layout and making it dirty repeatedly.
let cachedLuminances = this._toolbarLuminanceCache;
let luminances = new Map();
for (let toolbar of document.querySelectorAll(toolbarSelector)) {
// toolbars *should* all have ids, but guard anyway to avoid blowing up
let cacheKey =
toolbar.id && toolbar.id + JSON.stringify(this._windowState);
// lookup cached luminance value for this toolbar in this window state
let luminance = cacheKey && cachedLuminances.get(cacheKey);
if (isNaN(luminance)) {
let { r, g, b } = InspectorUtils.colorToRGBA(
getComputedStyle(toolbar).color
);
luminance = 0.2125 * r + 0.7154 * g + 0.0721 * b;
if (cacheKey) {
cachedLuminances.set(cacheKey, luminance);
}
}
luminances.set(toolbar, luminance);
}
const luminanceThreshold = 127; // In between 0 and 255
for (let [toolbar, luminance] of luminances) {
if (luminance <= luminanceThreshold) {
toolbar.removeAttribute("brighttext");
} else {
toolbar.setAttribute("brighttext", "true");
}
}
},
};
var PanicButtonNotifier = {
init() {
this._initialized = true;

View File

@@ -0,0 +1,138 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* Module is used set the "brighttext" attribute to `true` or remove it
* based on calculating a luminance value from the current toolbar color.
* This causes items like icons on the toolbar to contrast in brightness
* enough to be visible, depending on the current theme/coloring of the browser
* window. Calculated luminance values are cached in `state.toolbarLuminanceCache`. */
import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
// Track individual windowstates using WeakMap
const _windowStateMap = new WeakMap();
export const ToolbarIconColor = {
init(window) {
if (_windowStateMap.has(window)) {
return;
}
const state = {
active: false,
fullscreen: false,
customtitlebar: false,
toolbarLuminanceCache: new Map(),
};
_windowStateMap.set(window, state);
window.addEventListener("nativethemechange", this);
window.addEventListener("activate", this);
window.addEventListener("deactivate", this);
window.addEventListener("toolbarvisibilitychange", this);
window.addEventListener("windowlwthemeupdate", this);
// If the window isn't active now, we assume that it has never been active
// before and will soon become active such that inferFromText will be
// called from the initial activate event.
if (Services.focus.activeWindow == window) {
this.inferFromText("activate", window);
}
},
uninit(window) {
const state = _windowStateMap.get(window);
if (!state) {
return;
}
window.removeEventListener("nativethemechange", this);
window.removeEventListener("activate", this);
window.removeEventListener("deactivate", this);
window.removeEventListener("toolbarvisibilitychange", this);
window.removeEventListener("windowlwthemeupdate", this);
_windowStateMap.delete(window);
},
handleEvent(event) {
const window = event.target.ownerGlobal;
switch (event.type) {
case "activate":
case "deactivate":
case "nativethemechange":
case "windowlwthemeupdate":
this.inferFromText(event.type, window);
break;
case "toolbarvisibilitychange":
this.inferFromText(event.type, window, event.visible);
break;
}
},
inferFromText(reason, window, reasonValue) {
const state = _windowStateMap.get(window);
if (!state) {
return;
}
switch (reason) {
case "activate": // falls through
case "deactivate":
state.active = reason === "activate";
break;
case "fullscreen":
state.fullscreen = reasonValue;
break;
case "nativethemechange":
case "windowlwthemeupdate":
// theme change, we'll need to recalculate all color values
state.toolbarLuminanceCache.clear();
break;
case "toolbarvisibilitychange":
// toolbar changes dont require reset of the cached color values
break;
case "customtitlebar":
state.customtitlebar = reasonValue;
break;
}
let toolbarSelector = ".browser-toolbar:not([collapsed=true])";
if (AppConstants.platform == "macosx") {
toolbarSelector += ":not([type=menubar])";
}
// The getComputedStyle calls and setting the brighttext are separated in
// two loops to avoid flushing layout and making it dirty repeatedly.
let cachedLuminances = state.toolbarLuminanceCache;
let luminances = new Map();
for (let toolbar of window.document.querySelectorAll(toolbarSelector)) {
// toolbars *should* all have ids, but guard anyway to avoid blowing up
let cacheKey = toolbar.id && toolbar.id + JSON.stringify(state);
// lookup cached luminance value for this toolbar in this window state
let luminance = cacheKey && cachedLuminances.get(cacheKey);
if (isNaN(luminance)) {
let { r, g, b } = InspectorUtils.colorToRGBA(
window.getComputedStyle(toolbar).color
);
luminance = 0.2125 * r + 0.7154 * g + 0.0721 * b;
if (cacheKey) {
cachedLuminances.set(cacheKey, luminance);
}
}
luminances.set(toolbar, luminance);
}
const luminanceThreshold = 127; // In between 0 and 255
for (let [toolbar, luminance] of luminances) {
if (luminance <= luminanceThreshold) {
toolbar.removeAttribute("brighttext");
} else {
toolbar.setAttribute("brighttext", "true");
}
}
},
};

View File

@@ -10,6 +10,10 @@ with Files("**"):
with Files("ThemeVariableMap.sys.mjs"):
BUG_COMPONENT = ("WebExtensions", "Themes")
MOZ_SRC_FILES += [
"ToolbarIconColor.sys.mjs",
]
EXTRA_JS_MODULES += [
"BuiltInThemeConfig.sys.mjs",
"BuiltInThemes.sys.mjs",