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

Tweak api so it can be called multiple times

Browse Source 
to update the space item's properties.
This commit is contained in:
David Baker 2025-09-25 17:33:53 +01:00
parent 446830776f
commit cf869c9454
2 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -153,8 +153,7 @@ export interface DirectoryCustomisations {
// @alpha
export interface ExtrasApi {
// (undocumented)
addSpacePanelItem(renderer: SpacePanelItemRenderFunction): void;
setSpacePanelItem(spaceKey: string, props: SpacePanelItemProps): void;
}
// @public
@ -328,10 +327,21 @@ export interface RoomViewProps {
// @alpha @deprecated (undocumented)
export type RuntimeModuleConstructor = new (api: ModuleApi) => RuntimeModule;
// Warning: (ae-forgotten-export) The symbol "SpacePanelItemProps" needs to be exported by the entry point index.d.ts
//
// @alpha
export type SpacePanelItemRenderFunction = (props: SpacePanelItemProps) => JSX.Element;
export interface SpacePanelItemProps {
// (undocumented)
className?: string;
// (undocumented)
contextMenuTooltip?: string;
// (undocumented)
icon?: JSX.Element;
// (undocumented)
label: string;
// (undocumented)
onSelected?(): void;
// (undocumented)
style?: React.CSSProperties;
}
// @public
export type Translations = Record<string, {

20
packages/element-web-module-api/src/api/extras.ts
View File

@ -8,24 +8,17 @@ Please see LICENSE files in the repository root for full details.
import { JSX } from "react";
/**
* Any kind of event that can trigger a button
* @alpha
*/
export type ButtonEvent = React.MouseEvent<Element> | React.KeyboardEvent<Element> | React.FormEvent<Element>;
/**
* The type of the function used to render a space panel item.
* Properties of an item added to the Space panel
* @alpha
*/
export interface SpacePanelItemProps {
spaceKey?: string;
className?: string;
icon?: JSX.Element;
label: string;
contextMenuTooltip?: string;
style?: React.CSSProperties;
//notificationState?: NotificationState;
onClick?(ev?: ButtonEvent): void;
onSelected?(): void;
}
/**
@ -33,5 +26,12 @@ export interface SpacePanelItemProps {
* @alpha Subject to change.
*/
export interface ExtrasApi {
addSpacePanelItem(props: SpacePanelItemProps): void;
/**
* Inserts an item into the space panel as if it were a space button, below
* buttons for other spaces.
* If called again with the same spaceKey, will update the existing item.
* @param spaceKey - A key to identify this space-like item.
* @param props - Properties of the item to add.
*/
setSpacePanelItem(spaceKey: string, props: SpacePanelItemProps): void;
}