Source code
Revision control
Copy as Markdown
Other Tools
/* 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
import {
html,
ifDefined,
styleMap,
// eslint-disable-next-line import/no-unassigned-import
/**
* Sidebar with expanded and collapsed states that provides entry points
* to various sidebar panels and sidebar extensions.
*/
export default class SidebarMain extends MozLitElement {
static properties = {
bottomActions: { type: Array },
selectedView: { type: String },
sidebarItems: { type: Array },
open: { type: Boolean },
};
static queries = {
extensionButtons: { all: ".tools-and-extensions > moz-button[extension]" },
toolButtons: { all: ".tools-and-extensions > moz-button:not([extension])" },
customizeButton: ".bottom-actions > moz-button[view=viewCustomizeSidebar]",
};
constructor() {
super();
this.bottomActions = [];
this.selectedView = window.SidebarController.currentID;
this.open = window.SidebarController.isOpen;
this.contextMenuTarget = null;
}
connectedCallback() {
super.connectedCallback();
this._sidebarBox = document.getElementById("sidebar-box");
this._sidebarMain = document.getElementById("sidebar-main");
this._contextMenu = document.getElementById("sidebar-context-menu");
this._manageExtensionMenuItem = document.getElementById(
"sidebar-context-menu-manage-extension"
);
this._removeExtensionMenuItem = document.getElementById(
"sidebar-context-menu-remove-extension"
);
this._reportExtensionMenuItem = document.getElementById(
"sidebar-context-menu-report-extension"
);
this._sidebarBox.addEventListener("sidebar-show", this);
this._sidebarBox.addEventListener("sidebar-hide", this);
this._sidebarMain.addEventListener("contextmenu", this);
this._contextMenu.addEventListener("popuphidden", this);
this._contextMenu.addEventListener("command", this);
window.addEventListener("SidebarItemAdded", this);
window.addEventListener("SidebarItemChanged", this);
window.addEventListener("SidebarItemRemoved", this);
this.setCustomize();
}
disconnectedCallback() {
super.disconnectedCallback();
this._sidebarBox.removeEventListener("sidebar-show", this);
this._sidebarBox.removeEventListener("sidebar-hide", this);
this._sidebarMain.removeEventListener("contextmenu", this);
this._contextMenu.removeEventListener("popuphidden", this);
this._contextMenu.removeEventListener("command", this);
window.removeEventListener("SidebarItemAdded", this);
window.removeEventListener("SidebarItemChanged", this);
window.removeEventListener("SidebarItemRemoved", this);
}
onSidebarPopupShowing(event) {
// Store the context menu target which holds the id required for managing sidebar items
this.contextMenuTarget =
event.explicitOriginalTarget.flattenedTreeParentNode;
if (!this.contextMenuTarget.getAttribute("extensionId")) {
event.preventDefault();
}
}
async manageExtension() {
await window.BrowserAddonUI.manageAddon(
this.contextMenuTarget.getAttribute("extensionId"),
"sidebar-context-menu"
);
}
async removeExtension() {
await window.BrowserAddonUI.removeAddon(
this.contextMenuTarget.getAttribute("extensionId"),
"sidebar-context-menu"
);
}
async reportExtension() {
await window.BrowserAddonUI.reportAddon(
this.contextMenuTarget.getAttribute("extensionId"),
"sidebar-context-menu"
);
}
getImageUrl(icon, targetURI) {
if (window.IS_STORYBOOK) {
}
if (!icon) {
if (targetURI?.startsWith("moz-extension")) {
}
}
// If the icon is not for website (doesn't begin with http), we
// display it directly. Otherwise we go through the page-icon
// protocol to try to get a cached version. We don't load
// favicons directly.
if (icon.startsWith("http")) {
return `page-icon:${targetURI}`;
}
return icon;
}
getToolsAndExtensions() {
return window.SidebarController.toolsAndExtensions;
}
setCustomize() {
this.bottomActions.push(
...window.SidebarController.getCustomize().map(
({ commandID, icon, revampL10nId }) => ({
l10nId: revampL10nId,
icon,
view: commandID,
})
)
);
}
async handleEvent(e) {
switch (e.type) {
case "command":
switch (e.target.id) {
case "sidebar-context-menu-manage-extension":
await this.manageExtension();
break;
case "sidebar-context-menu-report-extension":
await this.reportExtension();
break;
case "sidebar-context-menu-remove-extension":
await this.removeExtension();
break;
}
break;
case "contextmenu":
this.onSidebarPopupShowing(e);
break;
case "popuphidden":
this.contextMenuTarget = null;
break;
case "sidebar-show":
this.selectedView = e.detail.viewId;
this.open = true;
break;
case "sidebar-hide":
this.open = false;
break;
case "SidebarItemAdded":
case "SidebarItemChanged":
case "SidebarItemRemoved":
this.requestUpdate();
break;
}
}
showView(e) {
let view = e.target.getAttribute("view");
window.SidebarController.toggle(view);
}
buttonType(action) {
return this.open && action.view == this.selectedView
? "icon"
: "icon ghost";
}
entrypointTemplate(action) {
return html`<moz-button
class="icon-button"
type=${this.buttonType(action)}
view=${action.view}
@click=${action.view ? this.showView : null}
title=${ifDefined(action.tooltiptext)}
data-l10n-id=${ifDefined(action.l10nId)}
style=${styleMap({ "--action-icon": action.icon })}
?extension=${action.view?.includes("-sidebar-action")}
extensionId=${ifDefined(action.extensionId)}
>
</moz-button>`;
}
render() {
let toolsAndExtensions = this.getToolsAndExtensions()
? this.getToolsAndExtensions()
: new Map();
return html`
<link
rel="stylesheet"
/>
<div class="wrapper">
<div class="tools-and-extensions actions-list">
${[...toolsAndExtensions.values()]
.filter(toolOrExtension => !toolOrExtension.disabled)
.map(action => this.entrypointTemplate(action))}
</div>
<div class="bottom-actions actions-list">
${this.bottomActions.map(action => this.entrypointTemplate(action))}
</div>
</div>
`;
}
}
customElements.define("sidebar-main", SidebarMain);