bigbluebutton-html-plugin-sdk
Version:
This repository contains the SDK for developing BigBlueButton plugins. Plugins are React components that can be loaded from external sources by the BigBlueButton HTML5 client to extend its functionalities.
44 lines (43 loc) • 1.6 kB
TypeScript
import { MediaAreaItemType } from './enums';
import { MediaAreaInterface, MediaAreaOptionProps, MediaAreaIconType } from './types';
export declare class MediaAreaOption implements MediaAreaInterface {
id: string;
type: MediaAreaItemType;
label: string;
icon: MediaAreaIconType;
tooltip: string;
dataTest: string;
allowed: boolean;
onClick: () => void;
/**
* Returns the option for the media area
*
* @param label - label to be displayed on the option
* @param icon - icon to be used in the button for the action bar - it can be the iconName
* from BigbBlueButton or an svg
* @param tooltip - tooltip to be displayed when hovering over option
* @param dataTest - string attribute to be used for testing
* @param allowed - boolean indicating whether the option should be displayed
* @param onClick - function to be called when clicking
*
* @returns the option to be displayed in the media area
*/
constructor({ id, label, icon, tooltip, dataTest, allowed, onClick, }: MediaAreaOptionProps);
setItemId: (id: string) => void;
}
export declare class MediaAreaSeparator implements MediaAreaInterface {
id: string;
dataTest?: string;
type: MediaAreaItemType;
/**
* Returns the separator for the media area
*
* @param dataTest - optional string attribute to be used for testing
*
* @returns the separator to be displayed in the media area
*/
constructor({ dataTest }: {
dataTest?: string | undefined;
});
setItemId: (id: string) => void;
}