diff --git a/packages/element-web-module-api/src/api/custom-components.ts b/packages/element-web-module-api/src/api/custom-components.ts index f9f4128c91..01d589341e 100644 --- a/packages/element-web-module-api/src/api/custom-components.ts +++ b/packages/element-web-module-api/src/api/custom-components.ts @@ -64,6 +64,15 @@ export interface CustomComponentsApi { * * @param eventType - The event type this renderer is for. Use a RegExp instance if you want to target multiple types. * @param renderer - The render function. + * @example + * ``` + * customComponents.registerMessageRenderer("m.room.message", (props, originalComponent) => { + * return ; + * }); + * customComponents.registerMessageRenderer(/m\.room\.(topic|name)/, (props, originalComponent) => { + * return ; + * }); + * ``` */ registerMessageRenderer(eventType: string | RegExp, renderer: CustomMessageRenderFunction): void; }