mirror of
https://github.com/zen-browser/components.git
synced 2025-07-08 10:20:08 +02:00
583 lines
No EOL
16 KiB
TypeScript
583 lines
No EOL
16 KiB
TypeScript
|
|
var gZenViewSplitter = new class {
|
|
constructor() {
|
|
this._data = [];
|
|
this.currentView = -1;
|
|
this._tabBrowserPanel = null;
|
|
this.__modifierElement = null;
|
|
this.__hasSetMenuListener = false;
|
|
|
|
window.addEventListener("TabClose", this.handleTabClose.bind(this));
|
|
this.initializeContextMenu();
|
|
this.insertPageActionButton();
|
|
}
|
|
|
|
/**
|
|
* @param {Event} event - The event that triggered the tab close.
|
|
* @description Handles the tab close event.7
|
|
*/
|
|
handleTabClose(event) {
|
|
const tab = event.target;
|
|
const groupIndex = this._data.findIndex(group => group.tabs.includes(tab));
|
|
if (groupIndex < 0) {
|
|
return;
|
|
}
|
|
this.removeTabFromGroup(tab, groupIndex, event.forUnsplit);
|
|
}
|
|
|
|
/**
|
|
* Removes a tab from a group.
|
|
*
|
|
* @param {Tab} tab - The tab to remove.
|
|
* @param {number} groupIndex - The index of the group.
|
|
* @param {boolean} forUnsplit - Indicates if the tab is being removed for unsplitting.
|
|
*/
|
|
removeTabFromGroup(tab, groupIndex, forUnsplit) {
|
|
const group = this._data[groupIndex];
|
|
const tabIndex = group.tabs.indexOf(tab);
|
|
group.tabs.splice(tabIndex, 1);
|
|
|
|
this.resetTabState(tab, forUnsplit);
|
|
|
|
if (group.tabs.length < 2) {
|
|
this.removeGroup(groupIndex);
|
|
} else {
|
|
this.updateSplitView(group.tabs[group.tabs.length - 1]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Resets the state of a tab.
|
|
*
|
|
* @param {Tab} tab - The tab to reset.
|
|
* @param {boolean} forUnsplit - Indicates if the tab is being reset for unsplitting.
|
|
*/
|
|
resetTabState(tab, forUnsplit) {
|
|
tab.splitView = false;
|
|
tab.linkedBrowser.zenModeActive = false;
|
|
const container = tab.linkedBrowser.closest(".browserSidebarContainer");
|
|
container.removeAttribute("zen-split");
|
|
container.removeAttribute("style");
|
|
|
|
if (!forUnsplit) {
|
|
tab.linkedBrowser.docShellIsActive = false;
|
|
} else {
|
|
container.style.gridArea = "1 / 1";
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes a group.
|
|
*
|
|
* @param {number} groupIndex - The index of the group to remove.
|
|
*/
|
|
removeGroup(groupIndex) {
|
|
if (this.currentView === groupIndex) {
|
|
this.resetSplitView();
|
|
}
|
|
this._data.splice(groupIndex, 1);
|
|
}
|
|
|
|
/**
|
|
* Resets the split view.
|
|
*/
|
|
resetSplitView() {
|
|
for (const tab of this._data[this.currentView].tabs) {
|
|
this.resetTabState(tab, true);
|
|
}
|
|
|
|
this.currentView = -1;
|
|
this.tabBrowserPanel.removeAttribute("zen-split-view");
|
|
this.tabBrowserPanel.style.gridTemplateAreas = "";
|
|
this.tabBrowserPanel.style.gridGap = "0px";
|
|
}
|
|
|
|
/**
|
|
* context menu item display update
|
|
*/
|
|
insetUpdateContextMenuItems() {
|
|
const contentAreaContextMenu = document.getElementById("tabContextMenu");
|
|
contentAreaContextMenu.addEventListener("popupshowing", () => {
|
|
const tabCountInfo = JSON.stringify({
|
|
tabCount: window.gBrowser.selectedTabs.length,
|
|
});
|
|
document
|
|
.getElementById("context_zenSplitTabs")
|
|
.setAttribute("data-l10n-args", tabCountInfo);
|
|
document.getElementById("context_zenSplitTabs").disabled =
|
|
!this.contextCanSplitTabs();
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Inserts the split link into the context menu.
|
|
*/
|
|
insertSplitLinkIntoContextMenu() {
|
|
const element = window.MozXULElement.parseXULToFragment(`
|
|
<menuitem id="context-split-with-newtab" data-l10n-id="floorp-split-view-open-menu"
|
|
oncommand="gSplitView.splitLinkInNewTab();" hidden="true"/>
|
|
<menuseparator id="context-stripOnShareLink"/>
|
|
`);
|
|
document.getElementById("context-stripOnShareLink").after(element);
|
|
}
|
|
|
|
/**
|
|
* Inserts the split view tab context menu item.
|
|
*/
|
|
insertSplitViewTabContextMenu() {
|
|
const element = window.MozXULElement.parseXULToFragment(`
|
|
<menuseparator/>
|
|
<menuitem id="context_zenSplitTabs"
|
|
data-lazy-l10n-id="tab-zen-split-tabs"
|
|
oncommand="gZenViewSplitter.contextSplitTabs();"/>
|
|
<menuseparator/>
|
|
`);
|
|
document.getElementById("context_closeDuplicateTabs").after(element);
|
|
}
|
|
|
|
/**
|
|
* Initializes the context menu.
|
|
*/
|
|
initializeContextMenu() {
|
|
this.insertSplitLinkIntoContextMenu();
|
|
this.insertSplitViewTabContextMenu();
|
|
this.insetUpdateContextMenuItems();
|
|
}
|
|
|
|
/**
|
|
* Insert Page Action button
|
|
*/
|
|
insertPageActionButton() {
|
|
const element = window.MozXULElement.parseXULToFragment(`
|
|
<hbox id="zen-split-views-box"
|
|
hidden="true"
|
|
role="button"
|
|
class="urlbar-page-action"
|
|
onclick="gZenViewSplitter.openSplitViewPanel(event);">
|
|
<image id="zen-split-views-button"
|
|
class="urlbar-icon"/>
|
|
</hbox>
|
|
`);
|
|
document.getElementById("star-button-box").after(element);
|
|
}
|
|
|
|
/**
|
|
* Gets the tab browser panel.
|
|
*
|
|
* @returns {Element} The tab browser panel.
|
|
*/
|
|
get tabBrowserPanel() {
|
|
if (!this._tabBrowserPanel) {
|
|
this._tabBrowserPanel = document.getElementById("tabbrowser-tabpanels");
|
|
}
|
|
return this._tabBrowserPanel;
|
|
}
|
|
|
|
/**
|
|
* Splits a link in a new tab.
|
|
*/
|
|
splitLinkInNewTab() {
|
|
const url =
|
|
window.gContextMenu.linkURL ||
|
|
window.gContextMenu.target.ownerDocument.location.href;
|
|
const currentTab = window.gBrowser.selectedTab;
|
|
const newTab = this.openAndSwitchToTab(url);
|
|
this.splitTabs([currentTab, newTab]);
|
|
}
|
|
|
|
/**
|
|
* Splits the selected tabs.
|
|
*/
|
|
contextSplitTabs() {
|
|
const tabs = window.gBrowser.selectedTabs;
|
|
this.splitTabs(tabs);
|
|
}
|
|
|
|
/**
|
|
* Checks if the selected tabs can be split.
|
|
*
|
|
* @returns {boolean} True if the tabs can be split, false otherwise.
|
|
*/
|
|
contextCanSplitTabs() {
|
|
if (window.gBrowser.selectedTabs.length < 2) {
|
|
return false;
|
|
}
|
|
for (const tab of window.gBrowser.selectedTabs) {
|
|
if (tab.splitView) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Handles the location change event.
|
|
*
|
|
* @param {Browser} browser - The browser instance.
|
|
*/
|
|
async onLocationChange(browser) {
|
|
const tab = window.gBrowser.getTabForBrowser(browser);
|
|
this.updateSplitViewButton(!tab?.splitView);
|
|
if (tab) {
|
|
this.updateSplitView(tab);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Splits the given tabs.
|
|
*
|
|
* @param {Tab[]} tabs - The tabs to split.
|
|
*/
|
|
splitTabs(tabs) {
|
|
if (tabs.length < 2) {
|
|
return;
|
|
}
|
|
|
|
const existingSplitTab = tabs.find(tab => tab.splitView);
|
|
if (existingSplitTab) {
|
|
const groupIndex = this._data.findIndex(group =>
|
|
group.tabs.includes(existingSplitTab)
|
|
);
|
|
if (groupIndex >= 0) {
|
|
this.updateSplitView(existingSplitTab);
|
|
return;
|
|
}
|
|
}
|
|
|
|
this._data.push({
|
|
tabs,
|
|
gridType: "grid",
|
|
});
|
|
window.gBrowser.selectedTab = tabs[0];
|
|
this.updateSplitView(tabs[0]);
|
|
}
|
|
|
|
/**
|
|
* Updates the split view.
|
|
*
|
|
* @param {Tab} tab - The tab to update the split view for.
|
|
*/
|
|
updateSplitView(tab) {
|
|
const splitData = this._data.find(group => group.tabs.includes(tab));
|
|
if (
|
|
!splitData ||
|
|
(this.currentView >= 0 &&
|
|
!this._data[this.currentView].tabs.includes(tab))
|
|
) {
|
|
this.updateSplitViewButton(true);
|
|
if (this.currentView >= 0) {
|
|
this.deactivateSplitView();
|
|
}
|
|
if (!splitData) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
this.activateSplitView(splitData, tab);
|
|
}
|
|
|
|
/**
|
|
* Deactivates the split view.
|
|
*/
|
|
deactivateSplitView() {
|
|
for (const tab of this._data[this.currentView].tabs) {
|
|
const container = tab.linkedBrowser.closest(".browserSidebarContainer");
|
|
this.resetContainerStyle(container);
|
|
container.removeEventListener("click", this.handleTabClick);
|
|
}
|
|
this.tabBrowserPanel.removeAttribute("zen-split-view");
|
|
this.tabBrowserPanel.style.gridTemplateAreas = "";
|
|
this.setTabsDocShellState(this._data[this.currentView].tabs, false);
|
|
this.currentView = -1;
|
|
}
|
|
|
|
/**
|
|
* Activates the split view.
|
|
*
|
|
* @param {object} splitData - The split data.
|
|
* @param {Tab} activeTab - The active tab.
|
|
*/
|
|
activateSplitView(splitData, activeTab) {
|
|
this.tabBrowserPanel.setAttribute("zen-split-view", "true");
|
|
this.currentView = this._data.indexOf(splitData);
|
|
|
|
const gridType = splitData.gridType || "grid";
|
|
this.applyGridLayout(splitData.tabs, gridType, activeTab);
|
|
|
|
this.setTabsDocShellState(splitData.tabs, true);
|
|
this.updateSplitViewButton(false);
|
|
}
|
|
|
|
/**
|
|
* Applies the grid layout to the tabs.
|
|
*
|
|
* @param {Tab[]} tabs - The tabs to apply the grid layout to.
|
|
* @param {string} gridType - The type of grid layout.
|
|
* @param {Tab} activeTab - The active tab.
|
|
*/
|
|
applyGridLayout(tabs, gridType, activeTab) {
|
|
const gridAreas = this.calculateGridAreas(tabs, gridType);
|
|
this.tabBrowserPanel.style.gridTemplateAreas = gridAreas;
|
|
|
|
tabs.forEach((tab, index) => {
|
|
tab.splitView = true;
|
|
const container = tab.linkedBrowser.closest(".browserSidebarContainer");
|
|
this.styleContainer(container, tab === activeTab, index, gridType);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Calculates the grid areas for the tabs.
|
|
*
|
|
* @param {Tab[]} tabs - The tabs.
|
|
* @param {string} gridType - The type of grid layout.
|
|
* @returns {string} The calculated grid areas.
|
|
*/
|
|
calculateGridAreas(tabs, gridType) {
|
|
if (gridType === "grid") {
|
|
return this.calculateGridAreasForGrid(tabs);
|
|
}
|
|
if (gridType === "vsep") {
|
|
return `'${tabs.map((_, j) => `tab${j + 1}`).join(" ")}'`;
|
|
}
|
|
if (gridType === "hsep") {
|
|
return tabs.map((_, j) => `'tab${j + 1}'`).join(" ");
|
|
}
|
|
return "";
|
|
}
|
|
|
|
/**
|
|
* Calculates the grid areas for the tabs in a grid layout.
|
|
*
|
|
* @param {Tab[]} tabs - The tabs.
|
|
* @returns {string} The calculated grid areas.
|
|
*/
|
|
calculateGridAreasForGrid(tabs) {
|
|
const rows = ["", ""];
|
|
tabs.forEach((_, i) => {
|
|
if (i % 2 === 0) {
|
|
rows[0] += ` tab${i + 1}`;
|
|
} else {
|
|
rows[1] += ` tab${i + 1}`;
|
|
}
|
|
});
|
|
|
|
if (tabs.length === 2) {
|
|
return "'tab1 tab2'";
|
|
}
|
|
|
|
if (tabs.length % 2 !== 0) {
|
|
rows[1] += ` tab${tabs.length}`;
|
|
}
|
|
|
|
return `'${rows[0].trim()}' '${rows[1].trim()}'`;
|
|
}
|
|
|
|
/**
|
|
* Styles the container for a tab.
|
|
*
|
|
* @param {Element} container - The container element.
|
|
* @param {boolean} isActive - Indicates if the tab is active.
|
|
* @param {number} index - The index of the tab.
|
|
* @param {string} gridType - The type of grid layout.
|
|
*/
|
|
styleContainer(container, isActive, index, gridType) {
|
|
container.removeAttribute("zen-split-active");
|
|
if (isActive) {
|
|
container.setAttribute("zen-split-active", "true");
|
|
}
|
|
container.setAttribute("zen-split-anim", "true");
|
|
container.addEventListener("click", this.handleTabClick);
|
|
|
|
if (gridType === "grid") {
|
|
container.style.gridArea = `tab${index + 1}`;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles the tab click event.
|
|
*
|
|
* @param {Event} event - The click event.
|
|
*/
|
|
handleTabClick = event => {
|
|
const container = event.currentTarget;
|
|
const tab = window.gBrowser.tabs.find(
|
|
t => t.linkedBrowser.closest(".browserSidebarContainer") === container
|
|
);
|
|
if (tab) {
|
|
window.gBrowser.selectedTab = tab;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Sets the docshell state for the tabs.
|
|
*
|
|
* @param {Tab[]} tabs - The tabs.
|
|
* @param {boolean} active - Indicates if the tabs are active.
|
|
*/
|
|
setTabsDocShellState(tabs, active) {
|
|
for (const tab of tabs) {
|
|
// zenModeActive allow us to avoid setting docShellisActive to false later on,
|
|
// see browser-custom-elements.js's patch
|
|
tab.linkedBrowser.zenModeActive = active;
|
|
try {
|
|
console.log(tab.linkedBrowser);
|
|
tab.linkedBrowser.docShellIsActive = active;
|
|
} catch (e) {
|
|
console.error(e);
|
|
}
|
|
const browser = tab.linkedBrowser.closest(".browserSidebarContainer");
|
|
if (active) {
|
|
browser.setAttribute("zen-split", "true");
|
|
const currentStyle = browser.getAttribute("style");
|
|
browser.setAttribute(
|
|
"style",
|
|
`${currentStyle}
|
|
-moz-subtree-hidden-only-visually: 0;
|
|
visibility: visible !important;`
|
|
);
|
|
} else {
|
|
browser.removeAttribute("zen-split");
|
|
browser.removeAttribute("style");
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Resets the container style.
|
|
*
|
|
* @param {Element} container - The container element.
|
|
*/
|
|
resetContainerStyle(container) {
|
|
container.removeAttribute("zen-split-active");
|
|
container.classList.remove("deck-selected");
|
|
container.style.gridArea = "";
|
|
}
|
|
|
|
/**
|
|
* Updates the split view button visibility.
|
|
*
|
|
* @param {boolean} hidden - Indicates if the button should be hidden.
|
|
*/
|
|
updateSplitViewButton(hidden) {
|
|
const button = document.getElementById("zen-split-views-box");
|
|
if (hidden) {
|
|
button?.setAttribute("hidden", "true");
|
|
} else {
|
|
button?.removeAttribute("hidden");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the modifier element.
|
|
*
|
|
* @returns {Element} The modifier element.
|
|
*/
|
|
get modifierElement() {
|
|
if (!this.__modifierElement) {
|
|
const wrapper = document.getElementById("template-zen-split-view-modifier");
|
|
const panel = wrapper.content.firstElementChild;
|
|
wrapper.replaceWith(wrapper.content);
|
|
this.__modifierElement = panel;
|
|
}
|
|
return this.__modifierElement;
|
|
}
|
|
|
|
/**
|
|
* Opens the split view panel.
|
|
*
|
|
* @param {Event} event - The event that triggered the panel opening.
|
|
*/
|
|
async openSplitViewPanel(event) {
|
|
const panel = this.modifierElement;
|
|
const target = event.target.parentNode;
|
|
this.updatePanelUI(panel);
|
|
|
|
if (!this.__hasSetMenuListener) {
|
|
this.setupPanelListeners(panel);
|
|
this.__hasSetMenuListener = true;
|
|
}
|
|
|
|
window.PanelMultiView.openPopup(panel, target, {
|
|
position: "bottomright topright",
|
|
triggerEvent: event,
|
|
}).catch(console.error);
|
|
}
|
|
|
|
/**
|
|
* Updates the UI of the panel.
|
|
*
|
|
* @param {Element} panel - The panel element.
|
|
*/
|
|
updatePanelUI(panel) {
|
|
for (const gridType of ["hsep", "vsep", "grid", "unsplit"]) {
|
|
const selector = panel.querySelector(
|
|
`.zen-split-view-modifier-preview.${gridType}`
|
|
);
|
|
selector.classList.remove("active");
|
|
if (
|
|
this.currentView >= 0 &&
|
|
this._data[this.currentView].gridType === gridType
|
|
) {
|
|
selector.classList.add("active");
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @description sets up the listeners for the panel.
|
|
* @param {Element} panel - The panel element
|
|
*/
|
|
setupPanelListeners(panel) {
|
|
for (const gridType of ["hsep", "vsep", "grid", "unsplit"]) {
|
|
const selector = panel.querySelector(
|
|
`.zen-split-view-modifier-preview.${gridType}`
|
|
);
|
|
selector.addEventListener("click", () =>
|
|
this.handlePanelSelection(gridType, panel)
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @description handles the panel selection.
|
|
* @param {string} gridType - The grid type
|
|
* @param {Element} panel - The panel element
|
|
*/
|
|
handlePanelSelection(gridType, panel) {
|
|
if (gridType === "unsplit") {
|
|
this.unsplitCurrentView();
|
|
} else {
|
|
this._data[this.currentView].gridType = gridType;
|
|
this.updateSplitView(window.gBrowser.selectedTab);
|
|
}
|
|
panel.hidePopup();
|
|
}
|
|
|
|
/**
|
|
* @description unsplit the current view.]
|
|
*/
|
|
unsplitCurrentView() {
|
|
const currentTab = window.gBrowser.selectedTab;
|
|
const tabs = this._data[this.currentView].tabs;
|
|
for (const tab of tabs) {
|
|
this.handleTabClose({ target: tab, forUnsplit: true });
|
|
}
|
|
window.gBrowser.selectedTab = currentTab;
|
|
this.updateSplitViewButton(true);
|
|
}
|
|
|
|
/**
|
|
* @description opens a new tab and switches to it.
|
|
* @param {string} url - The url to open
|
|
* @param {object} options - The options for the tab
|
|
* @returns {tab} The tab that was opened
|
|
*/
|
|
openAndSwitchToTab(url, options) {
|
|
const parentWindow = window.ownerGlobal.parent;
|
|
const targetWindow = parentWindow || window;
|
|
const tab = targetWindow.gBrowser.addTrustedTab(url, options);
|
|
targetWindow.gBrowser.selectedTab = tab;
|
|
return tab;
|
|
}
|
|
} |