mirrors/element-web
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2026-05-06 04:36:21 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #111 from element-hq/midhun/multiroom/builtins-api

Browse Source 
Render more components through builtins api
This commit is contained in:
R Midhun Suresh 2025-10-27 17:59:12 +05:30 committed by GitHub
commit 0f6ac0a841
2 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
packages/element-web-module-api/element-web-module-api.api.md
View File

@ -50,7 +50,8 @@ export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiEx
// @alpha
export interface BuiltinsApi {
getRoomViewComponent(): React.ComponentType<RoomViewProps>;
renderRoomAvatar(roomId: string, size?: string): React.ReactNode;
renderRoomView(roomId: string): React.ReactNode;
}
// @alpha @deprecated (undocumented)

16
packages/element-web-module-api/src/api/builtins.ts
View File

@ -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<RoomViewProps>;
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;
}