bigbluebutton-html-plugin-sdk 0.1.10 → 0.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,10 +1,10 @@
1
1
  import { MediaAreaItemType } from './enums';
2
- import { MediaAreaInterface, MediaAreaOptionProps } from './types';
2
+ import { MediaAreaInterface, MediaAreaOptionProps, MediaAreaIconType } from './types';
3
3
  export declare class MediaAreaOption implements MediaAreaInterface {
4
4
  id: string;
5
5
  type: MediaAreaItemType;
6
6
  label: string;
7
- icon: string;
7
+ icon: MediaAreaIconType;
8
8
  tooltip: string;
9
9
  dataTest: string;
10
10
  allowed: boolean;
@@ -13,7 +13,8 @@ export declare class MediaAreaOption implements MediaAreaInterface {
13
13
  * Returns the option for the media area
14
14
  *
15
15
  * @param label - label to be displayed on the option
16
- * @param icon - icon to be displayed on the option
16
+ * @param icon - icon to be used in the button for the action bar - it can be the iconName
17
+ * from BigbBlueButton or an svg
17
18
  * @param tooltip - tooltip to be displayed when hovering over option
18
19
  * @param dataTest - string attribute to be used for testing
19
20
  * @param allowed - boolean indicating whether the option should be displayed
@@ -8,7 +8,8 @@ var MediaAreaOption = /** @class */ (function () {
8
8
  * Returns the option for the media area
9
9
  *
10
10
  * @param label - label to be displayed on the option
11
- * @param icon - icon to be displayed on the option
11
+ * @param icon - icon to be used in the button for the action bar - it can be the iconName
12
+ * from BigbBlueButton or an svg
12
13
  * @param tooltip - tooltip to be displayed when hovering over option
13
14
  * @param dataTest - string attribute to be used for testing
14
15
  * @param allowed - boolean indicating whether the option should be displayed
@@ -17,7 +18,7 @@ var MediaAreaOption = /** @class */ (function () {
17
18
  * @returns the option to be displayed in the media area
18
19
  */
19
20
  function MediaAreaOption(_a) {
20
- var id = _a.id, _b = _a.label, label = _b === void 0 ? '' : _b, _c = _a.icon, icon = _c === void 0 ? '' : _c, _d = _a.tooltip, tooltip = _d === void 0 ? '' : _d, _e = _a.dataTest, dataTest = _e === void 0 ? '' : _e, _f = _a.allowed, allowed = _f === void 0 ? true : _f, _g = _a.onClick, onClick = _g === void 0 ? function () { } : _g;
21
+ var id = _a.id, _b = _a.label, label = _b === void 0 ? '' : _b, icon = _a.icon, _c = _a.tooltip, tooltip = _c === void 0 ? '' : _c, _d = _a.dataTest, dataTest = _d === void 0 ? '' : _d, _e = _a.allowed, allowed = _e === void 0 ? true : _e, _f = _a.onClick, onClick = _f === void 0 ? function () { } : _f;
21
22
  var _this = this;
22
23
  this.id = '';
23
24
  this.setItemId = function (id) {
@@ -1 +1 @@
1
- {"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/extensible-areas/media-area-item/component.ts"],"names":[],"mappings":";;;AAAA,iCAA4C;AAK5C,4BAA4B;AAE5B;IAiBE;;;;;;;;;;;OAWG;IACH,yBAAY,EAEW;YADrB,EAAE,QAAA,EAAE,aAAU,EAAV,KAAK,mBAAG,EAAE,KAAA,EAAE,YAAS,EAAT,IAAI,mBAAG,EAAE,KAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EAAE,gBAAa,EAAb,QAAQ,mBAAG,EAAE,KAAA,EAAE,eAAc,EAAd,OAAO,mBAAG,IAAI,KAAA,EAAE,eAAkB,EAAlB,OAAO,mBAAG,cAAO,CAAC,KAAA;QAD5F,iBAaC;QAzCD,OAAE,GAAW,EAAE,CAAC;QA2ChB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,0BAAmB,EAAE,CAAE,CAAC;QACpC,CAAC,CAAC;QAdA,IAAI,EAAE,EAAE;YACN,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;SACd;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,yBAAiB,CAAC,MAAM,CAAC;IACvC,CAAC;IAKH,sBAAC;AAAD,CAAC,AA/CD,IA+CC;AA/CY,0CAAe;AAiD5B;IAOE;;;;;;OAMG;IACH,4BAAY,EAAiB;YAAf,gBAAa,EAAb,QAAQ,mBAAG,EAAE,KAAA;QAA3B,iBAGC;QAhBD,OAAE,GAAW,EAAE,CAAC;QAkBhB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,6BAAsB,EAAE,CAAE,CAAC;QACvC,CAAC,CAAC;QANA,IAAI,CAAC,IAAI,GAAG,yBAAiB,CAAC,SAAS,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAKH,yBAAC;AAAD,CAAC,AAtBD,IAsBC;AAtBY,gDAAkB"}
1
+ {"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/extensible-areas/media-area-item/component.ts"],"names":[],"mappings":";;;AAAA,iCAA4C;AAK5C,4BAA4B;AAE5B;IAiBE;;;;;;;;;;;;OAYG;IACH,yBAAY,EAEW;YADrB,EAAE,QAAA,EAAE,aAAU,EAAV,KAAK,mBAAG,EAAE,KAAA,EAAE,IAAI,UAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EAAE,gBAAa,EAAb,QAAQ,mBAAG,EAAE,KAAA,EAAE,eAAc,EAAd,OAAO,mBAAG,IAAI,KAAA,EAAE,eAAkB,EAAlB,OAAO,mBAAG,cAAO,CAAC,KAAA;QADvF,iBAaC;QA1CD,OAAE,GAAW,EAAE,CAAC;QA4ChB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,0BAAmB,EAAE,CAAE,CAAC;QACpC,CAAC,CAAC;QAdA,IAAI,EAAE,EAAE;YACN,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;SACd;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,yBAAiB,CAAC,MAAM,CAAC;IACvC,CAAC;IAKH,sBAAC;AAAD,CAAC,AAhDD,IAgDC;AAhDY,0CAAe;AAkD5B;IAOE;;;;;;OAMG;IACH,4BAAY,EAAiB;YAAf,gBAAa,EAAb,QAAQ,mBAAG,EAAE,KAAA;QAA3B,iBAGC;QAhBD,OAAE,GAAW,EAAE,CAAC;QAkBhB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,6BAAsB,EAAE,CAAE,CAAC;QACvC,CAAC,CAAC;QANA,IAAI,CAAC,IAAI,GAAG,yBAAiB,CAAC,SAAS,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAKH,yBAAC;AAAD,CAAC,AAtBD,IAsBC;AAtBY,gDAAkB"}
@@ -1,13 +1,24 @@
1
+ /// <reference types="react" />
1
2
  import { PluginProvidedUiItemDescriptor } from '../base';
2
3
  /**
3
4
  * Interface for a generic item for the media area.
4
5
  */
5
6
  export interface MediaAreaInterface extends PluginProvidedUiItemDescriptor {
6
7
  }
8
+ export interface MediaAreaButtonIconSvg {
9
+ svgContent: React.SVGProps<SVGSVGElement>;
10
+ }
11
+ export interface MediaAreaButtonIconName {
12
+ /**
13
+ * Default icon name defined by BBB (see options there).
14
+ */
15
+ iconName: string;
16
+ }
17
+ export type MediaAreaIconType = MediaAreaButtonIconSvg | MediaAreaButtonIconName;
7
18
  export interface MediaAreaOptionProps {
8
19
  id?: string;
9
20
  label: string;
10
- icon: string;
21
+ icon: MediaAreaIconType;
11
22
  tooltip: string;
12
23
  dataTest?: string;
13
24
  allowed: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bigbluebutton-html-plugin-sdk",
3
- "version": "0.1.10",
3
+ "version": "0.1.11",
4
4
  "homepage": "https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",