diff --git a/packages/element-web-module-api/element-web-module-api.api.md b/packages/element-web-module-api/element-web-module-api.api.md index 2d341fde03..5aeb3eb2ed 100644 --- a/packages/element-web-module-api/element-web-module-api.api.md +++ b/packages/element-web-module-api/element-web-module-api.api.md @@ -50,7 +50,8 @@ export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiEx // @alpha export interface BuiltinsApi { - getRoomViewComponent(): React.ComponentType; + renderRoomAvatar(roomId: string, size?: string): React.ReactNode; + renderRoomView(roomId: string): React.ReactNode; } // @alpha @deprecated (undocumented) diff --git a/packages/element-web-module-api/src/api/builtins.ts b/packages/element-web-module-api/src/api/builtins.ts index 99d60e031f..cf43795576 100644 --- a/packages/element-web-module-api/src/api/builtins.ts +++ b/packages/element-web-module-api/src/api/builtins.ts @@ -25,11 +25,19 @@ export interface RoomViewProps { */ export interface BuiltinsApi { /** - * Returns the RoomView component used by Element Web to render a room such that - * modules can render it as part of their own custom room views. + * Render room avatar component from element-web. * * @alpha - * @returns The RoomView component. + * @param roomId - Id of the room + * @param size - Size of the avatar to render */ - getRoomViewComponent(): React.ComponentType; + renderRoomAvatar(roomId: string, size?: string): React.ReactNode; + + /** + * Render room view component from element-web. + * + * @alpha + * @param roomId - Id of the room + */ + renderRoomView(roomId: string): React.ReactNode; }