🤝 Add TooltipLabelProvider module for building tooltip texts using va…

…rious inputs

components/moz.build

@@ -26,9 +26,11 @@ DIRS += [
     "settings",
     "shortcuts",
     "startpage",
+    "status",
     "storage",
     "tabs",
     "toolbar",
+    "tooltips",
     "widgets",
 ]
 

components/tooltips/TooltipLabelProvider.sys.mjs

@@ -0,0 +1,43 @@
+/* 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/. */
+
+const tooltipL10n = new Localization(["dot/tooltips.ftl"], true);
+
+export const TooltipLabelProvider = {
+	/**
+	 * Constructs the tooltip text using the supplied values
+	 * @param {string} label
+	 * @param {object} [options]
+	 * @param {string} [options.sublabel]
+	 * @param {string} [options.shortcut]
+	 */
+	getTooltipText(label, options) {
+		let tooltipText = [];
+
+		if (options && options.shortcut) {
+			tooltipText.push(
+				tooltipL10n.formatValueSync("tooltip-shortcut-label", {
+					label,
+					shortcut: options.shortcut
+				})
+			);
+		} else {
+			tooltipText.push(
+				tooltipL10n.formatValueSync("tooltip-label", {
+					label
+				})
+			);
+		}
+
+		if (options && options.sublabel) {
+			tooltipText.push(
+				tooltipL10n.formatValueSync("tooltip-label", {
+					label: options.sublabel
+				})
+			);
+		}
+
+		return tooltipText.join("\n");
+	}
+};

components/widgets/content/browser-button.js

@@ -2,6 +2,10 @@
  * 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/. */
 
+var { TooltipLabelProvider } = ChromeUtils.importESModule(
+	"resource://gre/modules/TooltipLabelProvider.sys.mjs"
+);
+
 class BrowserButton extends BrowserContextualMixin(HTMLButtonElement) {
 	constructor() {
 		super();
@@ -103,8 +107,6 @@ class BrowserButton extends BrowserContextualMixin(HTMLButtonElement) {
 	 * Updates the label of the browser button
 	 */
 	set label(newLabel) {
-		if (newLabel == this.label) return;
-
 		this.setAttribute("label", newLabel);
 		this.elements.label.textContent = newLabel;
 
@@ -122,8 +124,6 @@ class BrowserButton extends BrowserContextualMixin(HTMLButtonElement) {
 	 * Updates the auxiliary label of the browser button
 	 */
 	set labelAuxiliary(newLabelAuxiliary) {
-		if (newLabelAuxiliary == this.labelAuxiliary) return;
-
 		this.setAttribute("labelauxiliary", newLabelAuxiliary);
 
 		this._updateTooltipText();
@@ -229,31 +229,20 @@ class BrowserButton extends BrowserContextualMixin(HTMLButtonElement) {
 	 * Computes the tooltip text for this button
 	 */
 	getTooltipText() {
-		let tooltipText = "";
-
 		const label = this.getAttribute("label");
 		const labelAuxiliary = this.getAttribute("labelauxiliary");
 		const accelerator = this.getAttribute("accelerator");
 
-		if (labelAuxiliary) {
-			tooltipText = labelAuxiliary;
-		} else if (label) {
-			tooltipText = label;
-		}
-
-		if (accelerator) {
-			tooltipText += ` (${accelerator})`;
-		}
-
-		return tooltipText;
+		return TooltipLabelProvider.getTooltipText(
+			labelAuxiliary || label || "",
+			{ shortcut: accelerator }
+		);
 	}
 
 	/**
 	 * Updates the button's tooltip text
 	 */
 	_updateTooltipText() {
-		if (this.elements.tooltip.state == "closed") return;
-
 		this.elements.tooltip.label = this.getTooltipText();
 	}
 

locales/en-US/dot/browser.ftl

@@ -45,5 +45,3 @@ browser-window-restore-button =
 
 browser-window-close-button =
     .title = Close
-
-browser-keybind-label = { $label } ({ $keybind })

locales/en-US/dot/tooltips.ftl

@@ -0,0 +1,11 @@
+# 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/.
+
+tooltip-label = { $label }
+
+tooltip-shortcut-label =
+    { PLATFORM() ->
+        [macos] { $label } { $shortcut }
+        *[other] { $label } ({ $shortcut })
+    }