Skip to content

Commit 5478cdc

Browse files
Merge pull request #111 from element-hq/midhun/multiroom/builtins-api
Render more components through builtins api
2 parents 39d670d + eb80cb8 commit 5478cdc

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

packages/element-web-module-api/element-web-module-api.api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiEx
5050

5151
// @alpha
5252
export interface BuiltinsApi {
53-
getRoomViewComponent(): React.ComponentType<RoomViewProps>;
53+
renderRoomAvatar(roomId: string, size?: string): React.ReactNode;
54+
renderRoomView(roomId: string): React.ReactNode;
5455
}
5556

5657
// @alpha @deprecated (undocumented)

packages/element-web-module-api/src/api/builtins.ts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,19 @@ export interface RoomViewProps {
2525
*/
2626
export interface BuiltinsApi {
2727
/**
28-
* Returns the RoomView component used by Element Web to render a room such that
29-
* modules can render it as part of their own custom room views.
28+
* Render room avatar component from element-web.
3029
*
3130
* @alpha
32-
* @returns The RoomView component.
31+
* @param roomId - Id of the room
32+
* @param size - Size of the avatar to render
3333
*/
34-
getRoomViewComponent(): React.ComponentType<RoomViewProps>;
34+
renderRoomAvatar(roomId: string, size?: string): React.ReactNode;
35+
36+
/**
37+
* Render room view component from element-web.
38+
*
39+
* @alpha
40+
* @param roomId - Id of the room
41+
*/
42+
renderRoomView(roomId: string): React.ReactNode;
3543
}

0 commit comments

Comments
 (0)