Files
element-web/test/unit-tests/components/views/rooms/RoomListPanel/RoomListPanel-test.tsx
David Baker 34450d513a Make landmark navigation work with new room list (#30747)
* Make landmark navigation work with new room list

Split out from https://github.com/element-hq/element-web/pull/30640

* Fix landmark selection to work with either room list

* Add test for landmark navigation

* Add test

* Fix test

* Clear mocks between runs
2025-09-12 09:24:56 +00:00

93 lines
3.5 KiB
TypeScript

/*
* 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 from "react";
import { render, screen } from "jest-matrix-react";
import { mocked } from "jest-mock";
import userEvent from "@testing-library/user-event";
import { RoomListPanel } from "../../../../../../src/components/views/rooms/RoomListPanel";
import { shouldShowComponent } from "../../../../../../src/customisations/helpers/UIComponents";
import { MetaSpace } from "../../../../../../src/stores/spaces";
import { LandmarkNavigation } from "../../../../../../src/accessibility/LandmarkNavigation";
import { ReleaseAnnouncementStore } from "../../../../../../src/stores/ReleaseAnnouncementStore";
jest.mock("../../../../../../src/customisations/helpers/UIComponents", () => ({
shouldShowComponent: jest.fn(),
}));
jest.mock("../../../../../../src/accessibility/LandmarkNavigation", () => ({
LandmarkNavigation: {
findAndFocusNextLandmark: jest.fn(),
},
Landmark: {
ROOM_SEARCH: "something",
},
}));
// mock out release announcements as they interfere with what's focused
// (this can be removed once the new room list announcement is gone)
jest.spyOn(ReleaseAnnouncementStore.instance, "getReleaseAnnouncement").mockReturnValue(null);
describe("<RoomListPanel />", () => {
function renderComponent() {
return render(<RoomListPanel activeSpace={MetaSpace.Home} />);
}
beforeEach(() => {
jest.clearAllMocks();
// By default, we consider shouldShowComponent(UIComponent.FilterContainer) should return true
mocked(shouldShowComponent).mockReturnValue(true);
});
it("should render the RoomListSearch component when UIComponent.FilterContainer is at true", () => {
renderComponent();
expect(screen.getByRole("button", { name: "Search Ctrl K" })).toBeInTheDocument();
});
it("should not render the RoomListSearch component when UIComponent.FilterContainer is at false", () => {
mocked(shouldShowComponent).mockReturnValue(false);
renderComponent();
expect(screen.queryByRole("button", { name: "Search Ctrl K" })).toBeNull();
});
it("should move to the next landmark when the shortcut key is pressed", async () => {
renderComponent();
const userEv = userEvent.setup();
// Pick something arbitrary and focusable in the room list component and focus it
const exploreRooms = screen.getByRole("button", { name: "Explore rooms" });
exploreRooms.focus();
expect(exploreRooms).toHaveFocus();
screen.getByRole("navigation", { name: "Room list" }).focus();
await userEv.keyboard("{Control>}{F6}{/Control}");
expect(LandmarkNavigation.findAndFocusNextLandmark).toHaveBeenCalled();
});
it("should not move to the next landmark if room list loses focus", async () => {
renderComponent();
const userEv = userEvent.setup();
// Pick something arbitrary and focusable in the room list component and focus it
const exploreRooms = screen.getByRole("button", { name: "Explore rooms" });
exploreRooms.focus();
expect(exploreRooms).toHaveFocus();
exploreRooms.blur();
expect(exploreRooms).not.toHaveFocus();
await userEv.keyboard("{Control>}{F6}{/Control}");
expect(LandmarkNavigation.findAndFocusNextLandmark).not.toHaveBeenCalled();
});
});