Maybe make api-extractor happy

This commit is contained in:
David Baker
2025-09-24 16:07:31 +01:00
parent 2cd86f7c3d
commit 9685775528
5 changed files with 61 additions and 2 deletions
@@ -5,6 +5,10 @@ SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE files in the repository root for full details.
*/
/**
* The props that must be passed to a RoomView component.
* @alpha Subject to change.
*/
export interface RoomViewProps {
roomId?: string;
}
@@ -13,6 +17,7 @@ export interface RoomViewProps {
* Exposes components that are part of Element Web to allow modules to render them
* as part of their custom components (because they can't import the components from
* Element Web since it would cause a dependency cycle)
* @alpha
*/
export interface BuiltinsApi {
getRoomViewComponent(): React.ComponentType<RoomViewProps>;
@@ -11,8 +11,16 @@ interface SpacePanelItemProps {
isPanelCollapsed: boolean;
}
/**
* The type of the function used to render a space panel item.
* @alpha
*/
export type SpacePanelItemRenderFunction = (props: SpacePanelItemProps) => JSX.Element;
/**
* API for inserting extra UI into Element Web.
* @alpha Subject to change.
*/
export interface ExtrasApi {
addSpacePanelItem(renderer: SpacePanelItemRenderFunction): void;
}
@@ -105,6 +105,10 @@ export interface Api
*/
readonly customComponents: CustomComponentsApi;
/**
* Allows modules to render components that are part of Element Web.
* @alpha
*/
readonly builtins: BuiltinsApi;
/**
@@ -113,6 +117,10 @@ export interface Api
*/
readonly navigation: NavigationApi;
/**
* Allows modules to insert extra UI into Element Web.
* @alpha
*/
readonly extras: ExtrasApi;
/**
@@ -7,11 +7,16 @@ Please see LICENSE files in the repository root for full details.
import { JSX } from "react";
/**
* A function called to render a component when a user navigates to the corresponding
* location. Currently renders alongside just the SpacePanel.
* @alpha
*/
export type LocationRenderFunction = () => JSX.Element;
/**
* API methods to navigate the application.
* @public
* @alpha
*/
export interface NavigationApi {
/**