Skip to content

Commit a7817e5

Browse files
committed
Add more docs
1 parent cf50965 commit a7817e5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/components/viewmodels/roomlist/RoomListViewModel.tsx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,16 @@ import type { Room } from "matrix-js-sdk/src/matrix";
99
import RoomListStoreV3 from "../../../stores/room-list-v3/RoomListStoreV3";
1010

1111
export interface RoomListViewState {
12+
/**
13+
* A list of rooms to be displayed in the left panel.
14+
*/
1215
rooms: Room[];
1316
}
1417

18+
/**
19+
* View model for the new room list
20+
* @see {@link RoomListViewState} for more information about what this view model returns.
21+
*/
1522
export function useRoomListViewModel(): RoomListViewState {
1623
const rooms = RoomListStoreV3.instance.getSortedRooms();
1724
return { rooms };

0 commit comments

Comments
 (0)