mirrors/element-web
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2026-05-04 19:56:45 +02:00
Code Issues Projects Releases Wiki Activity

Update custom components API to have @alpha stability.

Browse Source
This commit is contained in:
Half-Shot 2025-06-17 14:03:10 +01:00
parent e2a89888c2
commit 0d4a45d447
3 changed files with 7 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -22,6 +22,7 @@ export interface AliasCustomisations {
export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiExtension {
readonly config: ConfigApi;
createRoot(element: Element): Root;
// @alpha
readonly customComponents: CustomComponentsApi;
readonly i18n: I18nApi;
readonly rootNode: HTMLElement;
@ -59,11 +60,8 @@ export interface ConfigApi {
get<K extends keyof Config = never>(key?: K): Config | Config[K];
}
// @public
// @alpha
export interface CustomComponentsApi {
// Warning: (ae-incompatible-release-tags) The symbol "registerMessageRenderer" is marked as @public, but its signature references "MatrixEvent" which is marked as @beta
// Warning: (ae-incompatible-release-tags) The symbol "registerMessageRenderer" is marked as @public, but its signature references "CustomMessageRenderFunction" which is marked as @alpha
// Warning: (ae-incompatible-release-tags) The symbol "registerMessageRenderer" is marked as @public, but its signature references "CustomMessageRenderHints" which is marked as @alpha
registerMessageRenderer(eventTypeOrFilter: string | ((mxEvent: MatrixEvent) => boolean), renderer: CustomMessageRenderFunction, hints?: CustomMessageRenderHints): void;
}
@ -134,27 +132,15 @@ export interface LifecycleCustomisations {
onLoggedOutAndStorageCleared?(): void;
}
// @beta
// @alpha
export interface MatrixEvent {
// (undocumented)
age?: number;
// (undocumented)
content: Record<string, unknown>;
// (undocumented)
eventId: string;
// (undocumented)
originServerTs: number;
// (undocumented)
redacts?: string;
// (undocumented)
roomId?: string;
// (undocumented)
roomId: string;
sender: string;
// (undocumented)
stateKey?: string;
// (undocumented)
type: string;
// (undocumented)
unsigned: Record<string, unknown>;
}

4
packages/element-web-module-api/src/api/custom-components.ts
View File

@ -48,7 +48,7 @@ export type CustomMessageRenderHints = {
/**
* Function used to render a message component.
* @alpha Unlikely to change
* @alpha Subject to change.
*/
export type CustomMessageRenderFunction = (
/**
@ -63,7 +63,7 @@ export type CustomMessageRenderFunction = (
/**
* API for inserting custom components into Element.
* @public
* @alpha Subject to change.
*/
export interface CustomComponentsApi {
/**

2
packages/element-web-module-api/src/api/index.ts
View File

@ -90,7 +90,7 @@ export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiEx
/**
* The custom message component API.
* @public
* @alpha
*/
readonly customComponents: CustomComponentsApi;
/**