mirrors/element-web
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2026-05-11 15:16:35 +02:00
Code Issues Projects Releases Wiki Activity

Fix public/alpha statuses

Browse Source
This commit is contained in:
David Baker 2025-10-17 12:14:20 +01:00
parent e1f7a798a2
commit b5639c25a4
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
packages/element-web-module-api/element-web-module-api.api.md
View File

@ -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<void>;
}
// @alpha
// @public
export interface NavigationApi {
// (undocumented)
// @alpha
registerLocationRenderer(path: string, renderer: LocationRenderFunction): void;
toMatrixToLink(link: string, join?: boolean): Promise<void>;
}

8
packages/element-web-module-api/src/api/navigation.ts
View File

@ -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<void>;
/**
* 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;
}