Skip to content

Render more components through builtins api #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MidhunSureshR merged 3 commits into from
Oct 27, 2025
Merged

Render more components through builtins api #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e02a05a
Render RoomView instead of simply returning it
MidhunSureshR Oct 23, 2025
59064f4
Add method to render room avatar
MidhunSureshR Oct 23, 2025
eb80cb8
Update api doc
MidhunSureshR Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/element-web-module-api/element-web-module-api.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
16 changes: 12 additions & 4 deletions packages/element-web-module-api/src/api/builtins.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}