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.
43 lines (42 loc) • 1.66 kB
TypeScript
import { ActionButtonDropdownItemType } from './enums';
import { ActionButtonDropdownInterface, ActionButtonDropdownOptionProps } from './types';
export declare class ActionButtonDropdownOption implements ActionButtonDropdownInterface {
id: string;
type: ActionButtonDropdownItemType;
label: string;
icon: string;
tooltip: string;
dataTest: string;
allowed: boolean;
onClick: () => void;
/**
* Returns the option for the action button dropdown
*
* @param label - label to be displayed on the option
* @param icon - icon to be displayed on the option
* @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 action button dropdown
*/
constructor({ id, label, icon, tooltip, dataTest, allowed, onClick, }: ActionButtonDropdownOptionProps);
setItemId: (id: string) => void;
}
export declare class ActionButtonDropdownSeparator implements ActionButtonDropdownInterface {
id: string;
dataTest?: string;
type: ActionButtonDropdownItemType;
/**
* Returns the separator for the action button dropdown
*
* @param dataTest - optional string attribute to be used for testing
*
* @returns the separator to be displayed in the action button dropdown
*/
constructor({ dataTest }?: {
dataTest?: string | undefined;
});
setItemId: (id: string) => void;
}