Skip to content

Commit

Permalink
new script: add tabThumbnailTooltip.uc.js
Browse files Browse the repository at this point in the history
  • Loading branch information
aminomancer committed Feb 11, 2022
1 parent a7387d3 commit 73716d2
Show file tree
Hide file tree
Showing 2 changed files with 187 additions and 0 deletions.
183 changes: 183 additions & 0 deletions JS/tabThumbnailTooltip.uc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
// ==UserScript==
// @name Tab Thumbnail Tooltip
// @version 1.0
// @author aminomancer
// @homepage https://github.com/aminomancer/uc.css.js
// @description Show a large thumbnail image to preview tab content when hovering a tab.
// @license This Source Code Form is subject to the terms of the Creative Commons Attribution-NonCommercial-ShareAlike International License, v. 4.0. If a copy of the CC BY-NC-SA 4.0 was not distributed with this file, You can obtain one at http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
// ==/UserScript==

class TabThumbnail {
static config = {
"Preview width": 250, // Thumbnail width, in pixels (can override with CSS too)
"Preview height": 180, // Thumbnail height
"Update interval": 30, // How often to refresh the thumbnail, in milliseconds
};
get tooltip() {
return this._tooltip || (this._tooltip = document.getElementById("tabThumbTooltip"));
}
get tabLabel() {
return this._tabLabel || (this._tabLabel = this.tooltip.querySelector("#tabThumbLabel"));
}
get thumbBox() {
return this._thumbBox || (this._thumbBox = this.tooltip.querySelector("#tabThumbBox"));
}
constructor() {
this._updateTimer = null;
this.config = TabThumbnail.config;
const markup =
/* html */
`<tooltip
id="tabThumbTooltip"
noautohide="true"
orient="vertical"
onpopupshowing="ucTabThumbnail.onPopupShowing();"
onpopuphiding="ucTabThumbnail.onPopupHiding();"
hide-thumbnail="true"
style="visibility: collapse;">
<vbox id ="tabThumbBox" flex="true">
<description id="tabThumbLabel" class="tooltip-label" flex="true"/>
<toolbarseparator />
<hbox id="tabCanvasBox" flex="true">
<html:div id="tabThumbCanvas"></html:div>
</hbox>
</vbox>
</tooltip>`;
this.registerSheet();
document
.getElementById("mainPopupSet")
.appendChild(MozXULElement.parseXULToFragment(markup));
gBrowser.tabContainer.tooltip = "tabThumbTooltip";
addEventListener("unload", () => this.cancelTimer(), false);
}
async onPopupShowing() {
let ready = await this.showPreview();
if (ready) {
this.tooltip.style.removeProperty("visibility");
}
return ready;
}
onPopupHiding() {
this.tooltip.style.setProperty("visibility", "collapse");
this.cancelTimer();
}
async showPreview(update) {
let tab = this.tooltip.triggerNode?.closest(".tabbrowser-tab");
if (!tab) return false;
if (!update) {
this.tooltip.setAttribute("position", "after_start");
this.tooltip.moveToAnchor(tab, "after_start");
}
const { config } = this;
this.tabLabel.textContent = gBrowser.getTabTooltip(tab);
let canvas = PageThumbs.createCanvas(window);
let browser = tab.linkedBrowser;
let pending = tab.hasAttribute("pending") || !browser.browsingContext;
let docURI = pending ? browser?.currentURI : browser?.documentURI || browser?.currentURI;
let url = docURI?.spec;
let isBlank = !url || url === "about:blank";
if (isBlank || pending) {
this.tooltip.setAttribute("hide-thumbnail", "true");
} else {
await PageThumbs.captureToCanvas(
browser,
canvas,
{
backgroundColor: getComputedStyle(this.thumbBox).getPropertyValue(
"background-color"
),
fullViewport: true,
},
true
);
document.mozSetImageElement("tabThumbImageCanvas", canvas);
this.tooltip.removeAttribute("hide-thumbnail");
}
if (config["Update interval"] > 0) {
this._updateTimer = setTimeout(
() =>
requestIdleCallback(() => requestAnimationFrame(() => this.showPreview(true))),
config["Update interval"]
);
}
return true;
}
cancelTimer() {
if (this._updateTimer) {
clearTimeout(this._updateTimer);
this._updateTimer = null;
}
}
registerSheet() {
const { config } = this;
const css =
/* css */
`#tabThumbTooltip {
--tab-thumb-shadow-size: 6px;
--thumb-border-radius: calc(var(--arrowpanel-border-radius, 7px) - 3px);
appearance: none;
background: transparent;
border: none;
padding: var(--tab-thumb-shadow-size);
}
#tabThumbTooltip[position] {
margin-inline-start: calc(-1 * var(--tab-thumb-shadow-size));
margin-block-start: calc(-1 * var(--tab-thumb-shadow-size));
}
#tabThumbBox {
padding: 5px;
background: var(--arrowpanel-background);
color: var(--arrowpanel-color);
border: 1px solid transparent;
border-radius: var(--arrowpanel-border-radius);
box-shadow: 0 2px var(--tab-thumb-shadow-size) rgba(58,57,68,.2);
}
#tabThumbTooltip[hide-thumbnail] #tabThumbBox {
border-radius: max(3px, var(--thumb-border-radius));
}
#tabThumbLabel {
text-align: center;
margin-inline: 5px;
}
#tabThumbBox > toolbarseparator {
appearance: none;
min-height: 0;
border-top: 1px solid var(--panel-separator-color);
border-bottom: none;
margin: var(--panel-separator-margin);
margin-inline: 0;
padding: 0;
}
#tabThumbTooltip[hide-thumbnail] #tabCanvasBox,
#tabThumbTooltip[hide-thumbnail] #tabThumbBox > toolbarseparator {
display: none;
}
#tabThumbCanvas {
display: block;
border-radius: max(3px, var(--thumb-border-radius));
border: 1px solid var(--arrowpanel-border-color);
height: ${config["Preview height"]}px;
width: ${config["Preview width"]}px;
background-image: -moz-element(#tabThumbImageCanvas);
background-repeat: no-repeat;
background-size: cover;
}`;
let sss = Cc["@mozilla.org/content/style-sheet-service;1"].getService(
Ci.nsIStyleSheetService
);
let uri = makeURI("data:text/css;charset=UTF=8," + encodeURIComponent(css));
if (sss.sheetRegistered(uri, sss.AUTHOR_SHEET)) return;
sss.loadAndRegisterSheet(uri, sss.AUTHOR_SHEET);
}
}

if (gBrowserInit.delayedStartupFinished) window.ucTabThumbnail = new TabThumbnail();
else {
let delayedListener = (subject, topic) => {
if (topic == "browser-delayed-startup-finished" && subject == window) {
Services.obs.removeObserver(delayedListener, topic);
window.ucTabThumbnail = new TabThumbnail();
}
};
Services.obs.addObserver(delayedListener, "browser-delayed-startup-finished");
}
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1075,6 +1075,10 @@ So, this gives you some capabilities not already available in Firefox. In partic

</details>

#### [Tab Thumbnail Tooltip](/JS/tabThumbnailTooltip.uc.js):

Show a large thumbnail image to preview tab content when hovering a tab. Made [by request]("/../../issues/29").

#### [Tab Tooltip Navigation Buttons](/JS/tabTooltipNavButtons.uc.js):

This script turns the tab tooltip into a mini navigation popup with back, forward, and reload buttons. It still shows the tab's title and URL, and also shows its favicon. So it's similar to the vanilla tooltip, except it's interactive.<details><summary>💬 <i><b>More details...</b></i></summary>
Expand Down

0 comments on commit 73716d2

Please sign in to comment.