From b5639c25a42e2c23e580234a551bf19c77c1b5f8 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 17 Oct 2025 12:14:20 +0100 Subject: [PATCH] Fix public/alpha statuses --- .../element-web-module-api/element-web-module-api.api.md | 5 ++--- packages/element-web-module-api/src/api/navigation.ts | 8 +++++++- 2 files changed, 9 insertions(+), 4 deletions(-) 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 38e1e073a4..d617845bf0 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 @@ -44,7 +44,6 @@ export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiEx // @alpha readonly extras: ExtrasApi; readonly i18n: I18nApi; - // Warning: (ae-incompatible-release-tags) The symbol "navigation" is marked as @public, but its signature references "NavigationApi" which is marked as @alpha readonly navigation: NavigationApi; readonly rootNode: HTMLElement; } @@ -288,9 +287,9 @@ export class ModuleLoader { start(): Promise; } -// @alpha +// @public export interface NavigationApi { - // (undocumented) + // @alpha registerLocationRenderer(path: string, renderer: LocationRenderFunction): void; toMatrixToLink(link: string, join?: boolean): Promise; } diff --git a/packages/element-web-module-api/src/api/navigation.ts b/packages/element-web-module-api/src/api/navigation.ts index e5bef01287..f7d60b4263 100644 --- a/packages/element-web-module-api/src/api/navigation.ts +++ b/packages/element-web-module-api/src/api/navigation.ts @@ -16,7 +16,7 @@ export type LocationRenderFunction = () => JSX.Element; /** * API methods to navigate the application. - * @alpha + * @public */ export interface NavigationApi { /** @@ -26,5 +26,11 @@ export interface NavigationApi { */ toMatrixToLink(link: string, join?: boolean): Promise; + /** + * Register a renderer for a given location path. + * @param path - The location path to register the renderer for. + * @param renderer - The function that will render the component for the location. + * @alpha + */ registerLocationRenderer(path: string, renderer: LocationRenderFunction): void; }