Skip to content

Commit d8df089

Browse files
committed
Fix public/alpha statuses
1 parent 91efe7e commit d8df089

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

packages/element-web-module-api/element-web-module-api.api.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiEx
4444
// @alpha
4545
readonly extras: ExtrasApi;
4646
readonly i18n: I18nApi;
47-
// Warning: (ae-incompatible-release-tags) The symbol "navigation" is marked as @public, but its signature references "NavigationApi" which is marked as @alpha
4847
readonly navigation: NavigationApi;
4948
readonly rootNode: HTMLElement;
5049
}
@@ -288,9 +287,9 @@ export class ModuleLoader {
288287
start(): Promise<void>;
289288
}
290289

291-
// @alpha
290+
// @public
292291
export interface NavigationApi {
293-
// (undocumented)
292+
// @alpha
294293
registerLocationRenderer(path: string, renderer: LocationRenderFunction): void;
295294
toMatrixToLink(link: string, join?: boolean): Promise<void>;
296295
}

packages/element-web-module-api/src/api/navigation.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export type LocationRenderFunction = () => JSX.Element;
1616

1717
/**
1818
* API methods to navigate the application.
19-
* @alpha
19+
* @public
2020
*/
2121
export interface NavigationApi {
2222
/**
@@ -26,5 +26,11 @@ export interface NavigationApi {
2626
*/
2727
toMatrixToLink(link: string, join?: boolean): Promise<void>;
2828

29+
/**
30+
* Register a renderer for a given location path.
31+
* @param path - The location path to register the renderer for.
32+
* @param renderer - The function that will render the component for the location.
33+
* @alpha
34+
*/
2935
registerLocationRenderer(path: string, renderer: LocationRenderFunction): void;
3036
}

0 commit comments

Comments
 (0)