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.
31 lines (30 loc) • 1.61 kB
TypeScript
import { ScreenshareHelperItemType, ScreenshareHelperItemPosition } from './enums';
import { ScreenshareHelperButtonProps, ScreenshareHelperButtonInterface, ScreenshareHelperButtonOnclickCallback } from './types';
export declare class ScreenshareHelperButton implements ScreenshareHelperButtonInterface {
id: string;
type: ScreenshareHelperItemType;
label: string;
icon: string;
tooltip: string;
disabled: boolean;
position: ScreenshareHelperItemPosition;
onClick: (args: ScreenshareHelperButtonOnclickCallback) => void;
/**
* Returns object to be used in the setter for the Screenshare Helper. In this case,
* a button.
*
* @param label - label to be displayed in screenshare helper button (Not mandatory).
* @param tooltip - label to be displayed when hovering the screenshare helper button.
* @param icon - icon to be used in the screenshare helper button. It goes in the left side of it.
* @param onClick - function to be called when clicking the button.
* @param position - position to place the screenshare helper button.
* See {@link ScreenshareHelperItemPosition}
* @param hasSeparator - boolean indicating whether the screenshare helper button has separator
* (vertical bar)
* @param disabled - if true, the screenshare helper button will not be clickable
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
*/
constructor({ id, label, icon, tooltip, disabled, onClick, position, }: ScreenshareHelperButtonProps);
setItemId: (id: string) => void;
}