* Consolidate modules vitest coverage * Use vite-common as base for modules vitest config * Make knip happier * Fix coverage paths * Place modules unit tests alongside src * Switch to defineProject for better type safety * Consolidate vitest CI & coverage Kills off vite-common * Update comment * Update lockfile * Fix shared-components vitest config * Soften eslint config for tests in modules * Run eslint on modules/playwright dir too * Make tsc happy * Tweak modules to be disabled if config is missing * Restore blank line * Improve coverage * Potential fix for pull request finding 'Unused variable, import, function or class' Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
72 lines
3.0 KiB
TypeScript
72 lines
3.0 KiB
TypeScript
/*
|
|
Copyright 2025 New Vector Ltd.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import { type JSX } from "react";
|
|
import { TooltipProvider } from "@vector-im/compound-web";
|
|
|
|
import type { Module, Api, ModuleFactory } from "@element-hq/element-web-module-api";
|
|
import { CONFIG_KEY, WidgetTogglesConfig } from "./config";
|
|
import { WidgetToggle } from "./toggle";
|
|
import { name as ModuleName } from "../package.json";
|
|
|
|
class WidgetToggleModule implements Module {
|
|
public static readonly moduleApiVersion = "^1.12.0";
|
|
private config?: WidgetTogglesConfig;
|
|
|
|
public constructor(private api: Api) {}
|
|
|
|
public async load(): Promise<void> {
|
|
const rawConfig = this.api.config.get(CONFIG_KEY);
|
|
if (!rawConfig) {
|
|
console.debug(`No configuration found for module "${ModuleName}", skipping initialization.`);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
this.config = WidgetTogglesConfig.parse(rawConfig);
|
|
} catch (e) {
|
|
console.error("Failed to init module", e);
|
|
throw new Error(`Errors in module configuration for widget toggles module`);
|
|
}
|
|
|
|
this.api.extras.addRoomHeaderButtonCallback((roomId: string) => {
|
|
const widgets = this.api.widget.getWidgetsInRoom(roomId);
|
|
const toggleElements: JSX.Element[] = [];
|
|
|
|
for (const widget of widgets) {
|
|
if (this.config?.types.includes(widget.type)) {
|
|
toggleElements.push(
|
|
<WidgetToggle
|
|
app={widget}
|
|
roomId={roomId}
|
|
widgetApi={this.api.widget}
|
|
i18nApi={this.api.i18n}
|
|
/>,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (toggleElements.length === 0) return undefined;
|
|
|
|
// XXX: We shouldn't have to add another TooltipProvider here, it should
|
|
// be using the one in MatrixChat in Element Web, but thanks to the fact
|
|
// that contexts are "magically" identified by class, it doesn't pick up the
|
|
// context because we use a different copy of compound-web. We'll probably
|
|
// need to fix this at some point, possibly by moving compound's tooltip stuff
|
|
// out to its own mini-module that can be provided at runtime by Element Web,
|
|
// unless React make contexts more sensible.
|
|
// Annoyingly this does actually cause the tooltips to behave a bit weirdly:
|
|
// there's a delay before the tooltip appears when yo move between these buttons
|
|
// and the rest of the header buttons, whereas moving between the other header
|
|
// buttons, the tooltips appear straight away once one has appeared.
|
|
return <TooltipProvider>{toggleElements}</TooltipProvider>;
|
|
});
|
|
}
|
|
}
|
|
|
|
export default WidgetToggleModule satisfies ModuleFactory;
|