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.
39 lines (38 loc) • 1.58 kB
TypeScript
import { ActionsBarPosition, ActionsBarItemType } from './enums';
import { ActionsBarInterface, ActionsBarButtonProps, ActionsBarSeparatorProps } from './types';
export declare class ActionsBarButton implements ActionsBarInterface {
id: string;
type: ActionsBarItemType;
icon: string;
tooltip: string;
position: ActionsBarPosition;
onClick: () => void;
/**
* Returns object to be used in the setter for action bar. In this case,
* a button.
*
* @param icon - icon to be used in the button for the action bar
* @param tooltip - tooltip to be displayed when hovering the button
* @param onClick - function to be called when clicking the button
* @param position - position that this button will be displayed, see {@link ActionsBarPosition}
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5)
*/
constructor({ icon, tooltip, onClick, position, }: ActionsBarButtonProps);
setItemId: (id: string) => void;
}
export declare class ActionsBarSeparator implements ActionsBarInterface {
position: ActionsBarPosition;
id: string;
type: ActionsBarItemType;
/**
* Returns object to be used in the setter for action bar. In this case,
* a separator.
*
* @param position - position that this button will be displayed, see {@link ActionsBarPosition}
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5)
*/
constructor({ position, }: ActionsBarSeparatorProps);
setItemId: (id: string) => void;
}