firefox-main/devtools/client/settings/panel.mjs (file symbol)

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
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import { SettingChangedEvent } from "./events.mjs";
import { callbacks } from "./inventory.mjs";
/**
* @import { Toolbox } from "../framework/toolbox.js"
*/
/** The redesigned devtools settings panel. */
export class SettingsPanel {
#abortController = new AbortController();
/**
* @param {Window} iframeWindow
* @param {Toolbox} toolbox
*/
constructor(iframeWindow, toolbox) {
/** @type {Toolbox | null} */
this.toolbox = toolbox;
this.element = iframeWindow.document?.querySelector("devtools-settings");
}
/** @returns {this} */
open() {
this.element?.addEventListener(
SettingChangedEvent.eventName,
this.#onSettingChanged,
{ signal: this.#abortController.signal }
);
return this;
}
/** @param {SettingChangedEvent} event */
#onSettingChanged = event => {
if (!isCallbackName(event.action)) {
throw new Error(`Unknown settings callback "${event.action}".`);
}
if (!this.toolbox) {
// the panel might have been destroyed already
return;
}
callbacks[event.action]({ toolbox: this.toolbox });
};
destroy() {
this.#abortController.abort();
this.element = null;
this.toolbox = null;
}
}
/**
* @param {string} action
* @returns {action is keyof typeof callbacks}
*/
function isCallbackName(action) {
return Object.hasOwn(callbacks, action);
}