From 60687b27a6f6967e6ae5c92ad77448c5a50e4bfb Mon Sep 17 00:00:00 2001
From: Half-Shot <will@half-shot.uk>
Date: Thu, 5 Jun 2025 16:10:35 +0100
Subject: [PATCH] Add an example

---
 .../element-web-module-api/src/api/custom-components.ts  | 9 +++++++++
 1 file changed, 9 insertions(+)

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 <YourCustomComponent mxEvent={props.mxEvent} />;
+     *  });
+     *  customComponents.registerMessageRenderer(/m\.room\.(topic|name)/, (props, originalComponent) => {
+     *       return <YourCustomStateRenderer mxEvent={props.mxEvent} />;
+     *  });
+     * ```
      */
     registerMessageRenderer(eventType: string | RegExp, renderer: CustomMessageRenderFunction): void;
 }