Skip to content

Commit 0997e0a

Browse files
authored
refactor: rename RoomListView as RoomListPanel (#29361)
1 parent 6173c12 commit 0997e0a

28 files changed

+26
-26
lines changed

playwright/e2e/left-panel/room-list-view/room-list-view.spec.ts playwright/e2e/left-panel/room-list-panel/room-list-panel.spec.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { type Page } from "@playwright/test";
99

1010
import { test, expect } from "../../../element-web-test";
1111

12-
test.describe("Search section of the room list", () => {
12+
test.describe("Room list panel", () => {
1313
test.use({
1414
labsFlags: ["feature_new_room_list"],
1515
});
@@ -19,16 +19,16 @@ test.describe("Search section of the room list", () => {
1919
* @param page
2020
*/
2121
function getRoomListView(page: Page) {
22-
return page.getByTestId("room-list-view");
22+
return page.getByTestId("room-list-panel");
2323
}
2424

2525
test.beforeEach(async ({ page, app, user }) => {
2626
// The notification toast is displayed above the search section
2727
await app.closeNotificationToast();
2828
});
2929

30-
test("should render the room list view", { tag: "@screenshot" }, async ({ page, app, user }) => {
30+
test("should render the room list panel", { tag: "@screenshot" }, async ({ page, app, user }) => {
3131
const roomListView = getRoomListView(page);
32-
await expect(roomListView).toMatchScreenshot("room-list-view.png");
32+
await expect(roomListView).toMatchScreenshot("room-list-panel.png");
3333
});
3434
});

res/css/_components.pcss

+3-3
Original file line numberDiff line numberDiff line change
@@ -269,9 +269,9 @@
269269
@import "./views/right_panel/_VerificationPanel.pcss";
270270
@import "./views/right_panel/_WidgetCard.pcss";
271271
@import "./views/room_settings/_AliasSettings.pcss";
272-
@import "./views/rooms/RoomListView/_RoomListHeaderView.pcss";
273-
@import "./views/rooms/RoomListView/_RoomListSearch.pcss";
274-
@import "./views/rooms/RoomListView/_RoomListView.pcss";
272+
@import "./views/rooms/RoomListPanel/_RoomListHeaderView.pcss";
273+
@import "./views/rooms/RoomListPanel/_RoomListPanel.pcss";
274+
@import "./views/rooms/RoomListPanel/_RoomListSearch.pcss";
275275
@import "./views/rooms/_AppsDrawer.pcss";
276276
@import "./views/rooms/_Autocomplete.pcss";
277277
@import "./views/rooms/_AuxPanel.pcss";

res/css/views/rooms/RoomListView/_RoomListView.pcss res/css/views/rooms/RoomListPanel/_RoomListPanel.pcss

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* Please see LICENSE files in the repository root for full details.
66
*/
77

8-
.mx_RoomListView {
8+
.mx_RoomListPanel {
99
background-color: var(--cpd-color-bg-canvas-default);
1010
height: 100%;
1111
border-right: 1px solid var(--cpd-color-bg-subtle-primary);

src/components/structures/LeftPanel.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import PosthogTrackers from "../../PosthogTrackers";
3737
import type PageType from "../../PageTypes";
3838
import { Landmark, LandmarkNavigation } from "../../accessibility/LandmarkNavigation";
3939
import SettingsStore from "../../settings/SettingsStore";
40-
import { RoomListView } from "../views/rooms/RoomListView";
40+
import { RoomListPanel } from "../views/rooms/RoomListPanel";
4141

4242
interface IProps {
4343
isMinimized: boolean;
@@ -390,7 +390,7 @@ export default class LeftPanel extends React.Component<IProps, IState> {
390390
return (
391391
<div className={containerClasses}>
392392
<div className="mx_LeftPanel_roomListContainer">
393-
<RoomListView activeSpace={this.state.activeSpace} />
393+
<RoomListPanel activeSpace={this.state.activeSpace} />
394394
</div>
395395
</div>
396396
);

src/components/views/rooms/RoomListView/RoomListView.tsx src/components/views/rooms/RoomListPanel/RoomListPanel.tsx

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { UIComponent } from "../../../../settings/UIFeature";
1212
import { RoomListSearch } from "./RoomListSearch";
1313
import { RoomListHeaderView } from "./RoomListHeaderView";
1414

15-
type RoomListViewProps = {
15+
type RoomListPanelProps = {
1616
/**
1717
* Current active space
1818
* See {@link RoomListSearch}
@@ -21,13 +21,13 @@ type RoomListViewProps = {
2121
};
2222

2323
/**
24-
* A view component for the room list.
24+
* The panel of the room list
2525
*/
26-
export const RoomListView: React.FC<RoomListViewProps> = ({ activeSpace }) => {
26+
export const RoomListPanel: React.FC<RoomListPanelProps> = ({ activeSpace }) => {
2727
const displayRoomSearch = shouldShowComponent(UIComponent.FilterContainer);
2828

2929
return (
30-
<section className="mx_RoomListView" data-testid="room-list-view">
30+
<section className="mx_RoomListPanel" data-testid="room-list-panel">
3131
{displayRoomSearch && <RoomListSearch activeSpace={activeSpace} />}
3232
<RoomListHeaderView />
3333
</section>

src/components/views/rooms/RoomListView/index.ts src/components/views/rooms/RoomListPanel/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
* Please see LICENSE files in the repository root for full details.
66
*/
77

8-
export { RoomListView } from "./RoomListView";
8+
export { RoomListPanel } from "./RoomListPanel";

test/unit-tests/components/views/rooms/RoomListView/RoomListHeaderView-test.tsx test/unit-tests/components/views/rooms/RoomListPanel/RoomListHeaderView-test.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {
1414
type RoomListHeaderViewState,
1515
useRoomListHeaderViewModel,
1616
} from "../../../../../../src/components/viewmodels/roomlist/RoomListHeaderViewModel";
17-
import { RoomListHeaderView } from "../../../../../../src/components/views/rooms/RoomListView/RoomListHeaderView";
17+
import { RoomListHeaderView } from "../../../../../../src/components/views/rooms/RoomListPanel/RoomListHeaderView";
1818

1919
jest.mock("../../../../../../src/components/viewmodels/roomlist/RoomListHeaderViewModel", () => ({
2020
useRoomListHeaderViewModel: jest.fn(),

test/unit-tests/components/views/rooms/RoomListView/RoomListView-test.tsx test/unit-tests/components/views/rooms/RoomListPanel/RoomListPanel-test.tsx

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ import React from "react";
99
import { render, screen } from "jest-matrix-react";
1010
import { mocked } from "jest-mock";
1111

12-
import { RoomListView } from "../../../../../../src/components/views/rooms/RoomListView";
12+
import { RoomListPanel } from "../../../../../../src/components/views/rooms/RoomListPanel";
1313
import { shouldShowComponent } from "../../../../../../src/customisations/helpers/UIComponents";
1414
import { MetaSpace } from "../../../../../../src/stores/spaces";
1515

1616
jest.mock("../../../../../../src/customisations/helpers/UIComponents", () => ({
1717
shouldShowComponent: jest.fn(),
1818
}));
1919

20-
describe("<RoomListView />", () => {
20+
describe("<RoomListPanel />", () => {
2121
function renderComponent() {
22-
return render(<RoomListView activeSpace={MetaSpace.Home} />);
22+
return render(<RoomListPanel activeSpace={MetaSpace.Home} />);
2323
}
2424

2525
beforeEach(() => {

test/unit-tests/components/views/rooms/RoomListView/RoomListSearch-test.tsx test/unit-tests/components/views/rooms/RoomListPanel/RoomListSearch-test.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { render, screen } from "jest-matrix-react";
1010
import { mocked } from "jest-mock";
1111
import userEvent from "@testing-library/user-event";
1212

13-
import { RoomListSearch } from "../../../../../../src/components/views/rooms/RoomListView/RoomListSearch";
13+
import { RoomListSearch } from "../../../../../../src/components/views/rooms/RoomListPanel/RoomListSearch";
1414
import { MetaSpace } from "../../../../../../src/stores/spaces";
1515
import { shouldShowComponent } from "../../../../../../src/customisations/helpers/UIComponents";
1616
import defaultDispatcher from "../../../../../../src/dispatcher/dispatcher";

test/unit-tests/components/views/rooms/RoomListView/__snapshots__/RoomListView-test.tsx.snap test/unit-tests/components/views/rooms/RoomListPanel/__snapshots__/RoomListPanel-test.tsx.snap

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Jest Snapshot v1, https://goo.gl/fbAQLP
22

3-
exports[`<RoomListView /> should not render the RoomListSearch component when UIComponent.FilterContainer is at false 1`] = `
3+
exports[`<RoomListPanel /> should not render the RoomListSearch component when UIComponent.FilterContainer is at false 1`] = `
44
<DocumentFragment>
55
<section
6-
class="mx_RoomListView"
7-
data-testid="room-list-view"
6+
class="mx_RoomListPanel"
7+
data-testid="room-list-panel"
88
>
99
<header
1010
aria-label="Room options"
@@ -25,11 +25,11 @@ exports[`<RoomListView /> should not render the RoomListSearch component when UI
2525
</DocumentFragment>
2626
`;
2727

28-
exports[`<RoomListView /> should render the RoomListSearch component when UIComponent.FilterContainer is at true 1`] = `
28+
exports[`<RoomListPanel /> should render the RoomListSearch component when UIComponent.FilterContainer is at true 1`] = `
2929
<DocumentFragment>
3030
<section
31-
class="mx_RoomListView"
32-
data-testid="room-list-view"
31+
class="mx_RoomListPanel"
32+
data-testid="room-list-panel"
3333
>
3434
<div
3535
class="mx_Flex mx_RoomListSearch"

0 commit comments

Comments
 (0)