@ichicraft/widgets-widget-base 1.8.7 → 1.8.9

package/README.md

@@ -9,6 +9,20 @@ All notable changes to this project will be documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.8.9 - 2023-03-06
+
+-   Added `registerCustomCommandBarItems` function to the `instance` object of the `WidgetContext` interface, to support multiple custom buttons in the widget header.
+-   Added `unregisterCustomCommandBarItems` function to the `instance` object of the `WidgetContext` interface, to support removing all custom buttons in the widget header.
+-   Added optional `id` property to exported `CustomCommandBarItemProps` type, to support removing a custom command bar item by id.
+-   Added optional `pinned` property to exported `CustomCommandBarItemProps` type, to support forcing the widget header to always be visible.
+-   Added optional `showNotificationBadge` property to exported `CustomCommandBarItemProps` type, to support showing a red notification badge over the custom command bar item.
+-   Added optional `order` property to exported `CustomCommandBarItemProps` type, to support changing the order of custom command bar items.
+-   Changed `unregisterCustomCommandBarItem` function of the `instance` object of the `WidgetContext` interface, to support removing a custom command bar item by id.
+
+## 1.8.8 - 2023-02-16
+
+-   Removed all SharePoint and Teams dependencies.
+
 ## 1.8.7 - 2022-12-13
 
 -   Added `userRoles` property to the `WidgetContext` interface, to inform widgets of the roles of the current user.

package/lib/types/index.d.ts

@@ -1,6 +1,3 @@
-import { MSGraphClientFactory, AadTokenProviderFactory, AadHttpClientFactory } from '@microsoft/sp-http';
-import { IReadonlyTheme } from '@microsoft/sp-component-base';
-import * as microsoftTeams from '@microsoft/teams-js';
 /**
  * Widget context providing widget metadata and functionality offered by the widget board
  */
@@ -65,6 +62,12 @@ export interface WidgetContext {
          * Optional callback to handle the click event of the widget title.
          */
         onWidgetTitleClicked?: () => void;
+        /**
+         * Allows registration of multiple custom command bar items which can either result in an icon or
+         * an icon button, depending on the presence of the onClick property. To remove the items,
+         * use the [unregisterCommandBarItems] function.
+         */
+        registerCustomCommandBarItems?: (props: CustomCommandBarItemProps[]) => void;
         /**
          * Allows registration of a custom command bar item which can either result in an icon or
          * an icon button, depending on the presence of the onClick property. To remove the item,
@@ -72,9 +75,14 @@ export interface WidgetContext {
          */
         registerCustomCommandBarItem?: (props: CustomCommandBarItemProps) => void;
         /**
-         * Removes the custom command bar item that was added by the [registerCommandBarItem] function
+         * Removes all registered custom command bar items.
+         */
+        unregisterCustomCommandBarItems?: () => void;
+        /**
+         * Removes a single custom command bar item, corresponding to the provided id.
+         * If no id was specified, it removes all items.
          */
-        unregisterCustomCommandBarItem?: () => void;
+        unregisterCustomCommandBarItem?: (id?: string) => void;
         /**
          * Raises an event to be handled by the Time-based Events feature of Ichicraft Boards.
          * @param object The object this event concerns (e.g. app, report, newsArticle, ...). Use camelCase.
@@ -231,19 +239,19 @@ export interface WidgetContext {
     /**
      * MS Graph Client Factory class as provided by the WebPartContext object.
      */
-    msGraphClientFactory: MSGraphClientFactory;
+    msGraphClientFactory: any;
     /**
      * AAD Http Client Factory class as provided by the WebPartContext object.
      */
-    aadHttpClientFactory: AadHttpClientFactory;
+    aadHttpClientFactory: any;
     /**
      * AAD Token Provider Factory class as provided by the WebPartContext object.
      */
-    aadTokenProviderFactory: AadTokenProviderFactory;
+    aadTokenProviderFactory: any;
     /**
      * Currently in use theme (by SharePoint/Teams)
      */
-    theme: IReadonlyTheme;
+    theme: any;
     /**
      * Returns whether or not the currently signed in user is part of an AAD security group.
      * Provide the guid of the group.
@@ -293,11 +301,11 @@ export interface WidgetContext {
         /**
          * Microsoft Teams SDK.
          */
-        teamsJs: typeof microsoftTeams;
+        teamsJs: any;
         /**
          * {@inheritDoc @microsoft/teams-js#Context}
          */
-        context: microsoftTeams.Context;
+        context: any;
     };
 }
 export interface ValidationResult {
@@ -521,6 +529,10 @@ export declare enum CustomCommandBarItemSeverity {
  * rendering of a command bar item, which could either be a single Icon or an Icon Button
  */
 export interface CustomCommandBarItemProps {
+    /**
+     * Optional identifier for the icon.
+     */
+    id?: string;
     /**
      * Name of the icon, as specified and available in Fluent UI Iconography:
      * https://developer.microsoft.com/en-us/fluentui#/styles/web/icons
@@ -538,6 +550,18 @@ export interface CustomCommandBarItemProps {
      * Optional severity to specify how the item should render
      */
     severity?: CustomCommandBarItemSeverity;
+    /**
+     * Optionally tells the Widget Header that this icon should always be visible, even when not hovering
+     */
+    pinned?: boolean;
+    /**
+     * Optionally display a red notification icon badge in the top-right corner of the button.
+     */
+    showNotificationBadge?: boolean;
+    /**
+     * Optionally provide an order in which this button should appear, when registering multiple custom buttons.
+     */
+    order?: number;
     /**
      * Optional onClick event, which is triggered on user click and makes the command
      * bar item render as a button instead of a non-clickable icon

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.8.7",
+    "version": "1.8.9",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -18,11 +18,6 @@
     "files": [
         "lib/**/*"
     ],
-    "dependencies": {
-        "@microsoft/sp-component-base": "^1.11.0",
-        "@microsoft/sp-http": "1.11.0",
-        "@microsoft/teams-js": "1.9.0"
-    },
     "devDependencies": {
         "typescript": "^3.6.4"
     }