nikrozman/element-web
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Add options to hide header and composer of room view for the module api (#31095)

Browse Source 
* feat: add props to hide header in `RoomView`

* feat: add props to hide composer in `RoomView`

* feat: pass `RoomViewProps` to room view in `renderRoomView`

* refactor: add doc and use existing types

* test: add tests for new room view props
This commit is contained in:
Florian Duros
2025-11-05 13:52:10 +01:00
committed by GitHub
parent 52eb8a9979
commit 4d66a85e73
4 changed files with 491 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
test/unit-tests/components/structures/RoomView-test.tsx
View File

@@ -75,7 +75,7 @@ import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
import { type ViewUserPayload } from "../../../../src/dispatcher/payloads/ViewUserPayload.ts";
import { CallStore } from "../../../../src/stores/CallStore.ts";
import MediaDeviceHandler, { MediaDeviceKindEnum } from "../../../../src/MediaDeviceHandler.ts";
import Modal from "../../../../src/Modal.tsx";
import Modal, { type ComponentProps } from "../../../../src/Modal.tsx";
import ErrorDialog from "../../../../src/components/views/dialogs/ErrorDialog.tsx";
// Used by group calls
@@ -127,7 +127,10 @@ describe("RoomView", () => {
cleanup();
});
const mountRoomView = async (ref?: RefObject<RoomView | null>): Promise<RenderResult> => {
const mountRoomView = async (
ref?: RefObject<RoomView | null>,
props?: Partial<ComponentProps<typeof RoomView>>,
): Promise<RenderResult> => {
if (stores.roomViewStore.getRoomId() !== room.roomId) {
const switchedRoom = new Promise<void>((resolve) => {
const subFn = () => {
@@ -159,6 +162,7 @@ describe("RoomView", () => {
threepidInvite={undefined as any}
forceTimeline={false}
ref={ref}
{...props}
/>
</SDKContext.Provider>
</MatrixClientContext.Provider>,
@@ -250,6 +254,25 @@ describe("RoomView", () => {
expect(instance.getHiddenHighlightCount()).toBe(0);
});
it("should hide the composer when hideComposer=true", async () => {
// Join the room
jest.spyOn(room, "getMyMembership").mockReturnValue(KnownMembership.Join);
const { asFragment } = await mountRoomView(undefined, { hideComposer: true });
expect(screen.queryByRole("textbox", { name: "Send an unencrypted message…" })).not.toBeInTheDocument();
expect(asFragment()).toMatchSnapshot();
});
it("should hide the header when hideHeader=true", async () => {
// Join the room
jest.spyOn(room, "getMyMembership").mockReturnValue(KnownMembership.Join);
const { asFragment } = await mountRoomView(undefined, { hideHeader: true });
// Check that the room name button in the header is not rendered
expect(screen.queryByRole("button", { name: room.name })).not.toBeInTheDocument();
expect(asFragment()).toMatchSnapshot();
});
describe("invites", () => {
beforeEach(() => {
const member = new RoomMember(room.roomId, cli.getSafeUserId());