Add more docs

This commit is contained in:
David Baker
2025-10-17 12:10:07 +01:00
parent 6d0a715ac0
commit b83b5f4ad6
3 changed files with 30 additions and 8 deletions
@@ -21,5 +21,12 @@ export interface RoomViewProps {
* @alpha
*/
export interface BuiltinsApi {
/**
* Returns the RoomView component used by Element Web to render a room such that
* modules can render it as part of their own custom room views.
*
* @alpha
* @returns The RoomView component.
*/
getRoomViewComponent(): React.ComponentType<RoomViewProps>;
}
@@ -12,12 +12,34 @@ import { JSX } from "react";
* @alpha
*/
export interface SpacePanelItemProps {
/**
* A CSS class name for the item
*/
className?: string;
/**
* An icon to show in the item
*/
icon?: JSX.Element;
/**
* The label to show in the item
*/
label: string;
/**
* A tooltip to show when hovering over the item
*/
contextMenuTooltip?: string;
/**
* Styles to apply to the item
*/
style?: React.CSSProperties;
//notificationState?: NotificationState;
/**
* Callback when the item is selected
*/
onSelected?(): void;
}