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.
41 lines (40 loc) • 1.61 kB
TypeScript
import { OptionsDropdownItemType } from './enums';
import { OptionsDropdownInterface, OptionsDropdownOptionProps } from './types';
export declare class OptionsDropdownOption implements OptionsDropdownInterface {
id: string;
type: OptionsDropdownItemType;
label: string;
icon: string;
dataTest: string;
onClick: () => void;
/**
* Returns object to be used in the setter for the Options Dropdown. In this case,
* an option (Similar to a button, the user can click it).
*
* @param label - label to be displayed in the options dropdown option.
* @param icon - icon to be displayed in the options dropdown. It goes in the left side of it.
* @param dataTest - string attribute to be used for testing
* @param onClick - function to be called when clicking the option.
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
*/
constructor({ id, label, icon, dataTest, onClick, }: OptionsDropdownOptionProps);
setItemId: (id: string) => void;
}
export declare class OptionsDropdownSeparator implements OptionsDropdownInterface {
id: string;
type: OptionsDropdownItemType;
dataTest: string;
/**
* Returns object to be used in the setter for the Navigation Bar. In this case,
* a separator.
*
* @param dataTest - string attribute to be used for testing
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
*/
constructor({ dataTest }?: {
dataTest?: string | undefined;
});
setItemId: (id: string) => void;
}