MVVM WidgetContextMenu component to shared component

packages/shared-components/jest-sonar.xml

@@ -0,0 +1,7 @@
+<testExecutions version="1">
+ <file path="/home/marc/Workspace/element-web/packages/shared-components/src/right-panel/WidgetContextMenu/WidgetContextMenuView.test.tsx">
+  <testCase name="&lt;WidgetContextMenuView /&gt; renders widget contextmenu with all options" duration="93"/>
+  <testCase name="&lt;WidgetContextMenuView /&gt; renders widget contextmenu without only basic modification" duration="26"/>
+  <testCase name="&lt;WidgetContextMenuView /&gt; should attach vm methods" duration="201"/>
+ </file>
+</testExecutions>

packages/shared-components/src/index.ts

@@ -19,6 +19,7 @@ export * from "./rich-list/RichItem";
 export * from "./rich-list/RichList";
 export * from "./utils/Box";
 export * from "./utils/Flex";
+export * from "./right-panel/WidgetContextMenu";
 
 // Utils
 export * from "./utils/i18n";

packages/shared-components/src/right-panel/WidgetContextMenu/WidgetContextMenuView.stories.tsx

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+import React, { type JSX } from "react";
+import { fn } from "storybook/test";
+
+import type { Meta, StoryFn } from "@storybook/react-vite";
+import { useMockedViewModel } from "../../useMockedViewModel";
+import { WidgetContextMenuAction, WidgetContextMenuSnapshot, WidgetContextMenuView } from "./WidgetContextMenuView";
+import { IconButton } from "@vector-im/compound-web";
+import TriggerIcon from "@vector-im/compound-design-tokens/assets/web/icons/overflow-horizontal";
+
+type WidgetContextMenuViewModelProps = WidgetContextMenuSnapshot & WidgetContextMenuAction;
+
+const WidgetContextMenuViewWrapper = ({
+    onStreamAudioClick,
+    onEditClick,
+    onSnapshotClick,
+    onDeleteClick,
+    onRevokeClick,
+    onFinished,
+    onMoveButton,
+    ...rest
+}: WidgetContextMenuViewModelProps): JSX.Element => {
+    const vm = useMockedViewModel(rest, {
+        onStreamAudioClick,
+        onEditClick,
+        onSnapshotClick,
+        onDeleteClick,
+        onRevokeClick,
+        onFinished,
+        onMoveButton,
+    });
+    return <WidgetContextMenuView vm={vm} />;
+};
+
+export default {
+    title: "RightPanel/WidgetContextMenuView",
+    component: WidgetContextMenuViewWrapper,
+    tags: ["autodocs"],
+    args: {
+        showStreamAudioStreamButton: true,
+        showEditButton: true,
+        showRevokeButton: true,
+        showDeleteButton: true,
+        showSnapshotButton: true,
+        showMoveButtons: [true, true],
+        canModify: true,
+        widgetMessaging: undefined,
+        isMenuOpened: true,
+        trigger: (
+            <IconButton size="24px">
+                <TriggerIcon />
+            </IconButton>
+        ),
+        onStreamAudioClick: fn(),
+        onEditClick: fn(),
+        onSnapshotClick: fn(),
+        onDeleteClick: fn(),
+        onRevokeClick: fn(),
+        onFinished: fn(),
+        onMoveButton: fn(),
+    },
+} as Meta<typeof WidgetContextMenuViewWrapper>;
+
+const Template: StoryFn<typeof WidgetContextMenuViewWrapper> = (args) => <WidgetContextMenuViewWrapper {...args} />;
+
+export const Default = Template.bind({});
+
+export const OnlyBasicModification = Template.bind({});
+OnlyBasicModification.args = {
+    showSnapshotButton: false,
+    showMoveButtons: [false, false],
+    showStreamAudioStreamButton: false,
+    showEditButton: false,
+};

packages/shared-components/src/right-panel/WidgetContextMenu/WidgetContextMenuView.test.tsx

@@ -0,0 +1,110 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2023 Mikhail Aheichyk
+Copyright 2023 Nordeck IT + Consulting GmbH.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+import React from "react";
+import { screen, render } from "jest-matrix-react";
+import userEvent from "@testing-library/user-event";
+import { WidgetContextMenuAction, WidgetContextMenuSnapshot, WidgetContextMenuView } from "./WidgetContextMenuView";
+import * as stories from "./WidgetContextMenuView.stories.tsx";
+import { MockViewModel } from "../../viewmodel/MockViewModel.ts";
+import { IconButton } from "@vector-im/compound-web";
+import { composeStories } from "@storybook/react-vite";
+import TriggerIcon from "@vector-im/compound-design-tokens/assets/web/icons/overflow-horizontal";
+
+const { Default, OnlyBasicModification } = composeStories(stories);
+
+describe("<WidgetContextMenuView />", () => {
+
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+
+
+    it("renders widget contextmenu with all options", () => {
+        const { container } = render(<Default />);
+        expect(container).toMatchSnapshot();
+    });
+
+    it("renders widget contextmenu without only basic modification", () => {
+        const { container } = render(<OnlyBasicModification />);
+        expect(container).toMatchSnapshot();
+    });
+
+    const onKeyDown = jest.fn();
+    const togglePlay = jest.fn();
+    const onSeekbarChange = jest.fn();
+
+    const onStreamAudioClick = jest.fn();
+    const onEditClick = jest.fn();
+    const onSnapshotClick = jest.fn();
+    const onDeleteClick = jest.fn();
+    const onRevokeClick = jest.fn();
+    const onFinished = jest.fn();
+    const onMoveButton = jest.fn();
+    class WidgetContextMenuViewModel
+        extends MockViewModel<WidgetContextMenuSnapshot>
+        implements WidgetContextMenuAction
+    {
+        public onKeyDown = onKeyDown;
+        public togglePlay = togglePlay;
+        public onSeekbarChange = onSeekbarChange;
+
+        public onStreamAudioClick = onStreamAudioClick;
+        public onEditClick = onEditClick;
+        public onSnapshotClick = onSnapshotClick;
+        public onDeleteClick = onDeleteClick;
+        public onRevokeClick = onRevokeClick;
+        public onFinished = onFinished;
+        public onMoveButton = onMoveButton;
+    };
+
+    const defaultValue: WidgetContextMenuSnapshot = {
+        showStreamAudioStreamButton: true,
+        showEditButton: true,
+        showRevokeButton: true,
+        showDeleteButton: true,
+        showSnapshotButton: true,
+        showMoveButtons: [true, true],
+        canModify: true,
+        widgetMessaging: undefined,
+        isMenuOpened: true,
+        trigger: (
+            <IconButton size="24px">
+                <TriggerIcon />
+            </IconButton>
+        ),
+    };
+
+    it("should attach vm methods", async () => {
+        const vm = new WidgetContextMenuViewModel(defaultValue);
+
+        render(<WidgetContextMenuView vm={vm} />);
+
+        await userEvent.click(screen.getByRole("menuitem", { name: "Start audio stream" }));
+        expect(onStreamAudioClick).toHaveBeenCalled();
+
+        await userEvent.click(screen.getByRole("menuitem", { name: "Edit" }));
+        expect(onEditClick).toHaveBeenCalled();
+
+        await userEvent.click(screen.getByRole("menuitem", { name: "Take a picture" }));
+        expect(onSnapshotClick).toHaveBeenCalled();
+
+        await userEvent.click(screen.getByRole("menuitem", { name: "Revoke permissions" }));
+        expect(onRevokeClick).toHaveBeenCalled();
+
+        await userEvent.click(screen.getByRole("menuitem", { name: "Remove for everyone" }));
+        expect(onDeleteClick).toHaveBeenCalled();
+
+        await userEvent.click(screen.getByRole("menuitem", { name: "Move left" }));
+        expect(onMoveButton).toHaveBeenCalledWith(-1);
+
+        await userEvent.click(screen.getByRole("menuitem", { name: "Move right" }));
+        expect(onMoveButton).toHaveBeenCalledWith(1);
+    });
+});

packages/shared-components/src/right-panel/WidgetContextMenu/WidgetContextMenuView.tsx

@@ -0,0 +1,130 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+import React, { ReactNode, type JSX } from "react";
+import { type ClientWidgetApi } from "matrix-widget-api";
+import { Menu, MenuItem } from "@vector-im/compound-web";
+
+import { _t } from "../../utils/i18n.tsx";
+import { type ViewModel } from "../../viewmodel/ViewModel.ts";
+import { useViewModel } from "../../useViewModel.ts";
+
+export interface WidgetContextMenuSnapshot {
+    showStreamAudioStreamButton: boolean;
+    showEditButton: boolean;
+    showRevokeButton: boolean;
+    showDeleteButton: boolean;
+    showSnapshotButton: boolean;
+    showMoveButtons: [boolean, boolean];
+    canModify: boolean;
+    widgetMessaging: ClientWidgetApi | undefined;
+    isMenuOpened: boolean;
+    trigger: ReactNode;
+}
+
+export interface WidgetContextMenuAction {
+    onStreamAudioClick: () => Promise<void>;
+    onEditClick: () => void;
+    onSnapshotClick: () => void;
+    onDeleteClick: () => void;
+    onRevokeClick: () => void;
+    onFinished: () => void;
+    onMoveButton: (direction: number) => void;
+}
+
+export type WidgetContextMenuViewModel = ViewModel<WidgetContextMenuSnapshot> & WidgetContextMenuAction;
+
+interface WidgetContextMenuViewProps {
+    vm: WidgetContextMenuViewModel;
+}
+
+export const WidgetContextMenuView: React.FC<WidgetContextMenuViewProps> = ({
+   vm
+}) => {
+
+    const {
+        showStreamAudioStreamButton,
+        showEditButton,
+        showSnapshotButton,
+        showDeleteButton,
+        showRevokeButton,
+        showMoveButtons,
+        isMenuOpened,
+        trigger,
+    }= useViewModel(vm);
+
+    let streamAudioStreamButton: JSX.Element | undefined;
+    if (showStreamAudioStreamButton) {
+        streamAudioStreamButton = (
+            <MenuItem
+                onSelect={vm.onStreamAudioClick}
+                label={_t("widget|context_menu|start_audio_stream")}
+            />
+        );
+    }
+
+    let editButton: JSX.Element | undefined;
+    if (showEditButton) {
+        editButton = <MenuItem onSelect={vm.onEditClick} label={_t("action|edit")} />;
+    }
+
+    let snapshotButton: JSX.Element | undefined;
+    if (showSnapshotButton) {
+        snapshotButton = (
+            <MenuItem onSelect={vm.onSnapshotClick} label={_t("widget|context_menu|screenshot")} />
+        );
+    }
+
+    let deleteButton: JSX.Element | undefined;
+    if (showDeleteButton) {
+        deleteButton = (
+            <MenuItem
+                onSelect={vm.onDeleteClick}
+                // TODO label={userWidget ? _t("action|remove") : _t("widget|context_menu|remove")}
+                label={_t("widget|context_menu|remove")}
+            />
+        );
+    }
+
+    let revokeButton: JSX.Element | undefined;
+    if (showRevokeButton) {
+        revokeButton = (
+            <MenuItem onSelect={vm.onRevokeClick} label={_t("widget|context_menu|revoke")} />
+        );
+    }
+
+    const [showMoveLeftButton, showMoveRightButton] = showMoveButtons;
+    let moveLeftButton: JSX.Element | undefined;
+    if (showMoveLeftButton) {
+        moveLeftButton = <MenuItem onSelect={() => vm.onMoveButton(-1)} label={_t("widget|context_menu|move_left")} />;
+    }
+
+    let moveRightButton: JSX.Element | undefined;
+    if (showMoveRightButton) {
+        moveRightButton = <MenuItem onSelect={() => vm.onMoveButton(1)} label={_t("widget|context_menu|move_right")} />;
+    }
+
+    return (
+        <Menu
+            title="Widget context menu"
+            open={isMenuOpened}
+            showTitle={false}
+            side="right"
+            align="start"
+            trigger={trigger}
+            onOpenChange={vm.onFinished}
+        >
+            {streamAudioStreamButton}
+            {editButton}
+            {revokeButton}
+            {deleteButton}
+            {snapshotButton}
+            {moveLeftButton}
+            {moveRightButton}
+        </Menu>
+    );
+};