@ichicraft/widgets-widget-base 1.10.2 → 1.10.4

package/README.md

@@ -9,6 +9,18 @@ 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.10.4 - 2024-07-23
+
+-   Added `SearchBar` value to the `CommandBarItemType` enum, to allow rendering a command bar item as a search bar.
+-   Added `CommandBarSearchItem` interface, to allow passing extra search-related props to a CommandBarItem of type `SearchBar`.
+-   Added optional `overflowButtonIconName` and `overflowButtonTooltip` properties to the `CommandBarTabOptions` interface, to allow customization of the overflow menu button.
+-   Added optional `itemCount` property to the `CommandBarTab` interface.
+-   Added summaries to functions and interfaces related to widget command bar tabs.
+
+## 1.10.3 - 2024-07-22
+
+-   Added override in package.json to use version `2.3.7` instead of `2.3.6` of `requirejs` because the latter has vulnerability CVE-2024-38999
+
 ## 1.10.2 - 2024-07-19
 
 -   Added `registerTabs` function to the `WidgetInstanceContext` interface, to allow rendering of tabs in the widget header.

package/lib/types/index.d.ts

@@ -324,7 +324,7 @@ export interface WidgetInstanceContext {
      */
     unregisterCustomCommandBarItem?: (id?: string) => void;
     /**
-     * Allows registration of tabs (pivots) in the widget header.
+     * Allows registration of tabs (pivots) in the widget header. To unregister the tabs, provide 'undefined' options.
      */
     registerTabs?: (options: CommandBarTabOptions) => void;
     /**
@@ -610,6 +610,8 @@ export declare enum CommandBarItemType {
     Icon = "icon",
     /** Renders the item as a clickable link */
     Link = "link",
+    /** Renders the item as a search bar */
+    SearchBar = "search-bar",
     /** Renders the item in the overflow menu */
     Overflow = "overflow"
 }
@@ -654,11 +656,11 @@ export interface CommandBarItemProps {
      * See the available icon names in Fluent UI Iconography:
      * https://developer.microsoft.com/en-us/fluentui#/styles/web/icons
      */
-    iconName: string;
+    iconName?: string;
     /**
      * Displayed label when rendered as a link, or in the overflow menu.
      */
-    label: string;
+    label?: string;
     /**
      * Optionally display a red notification icon badge in the top-right corner of the button.
      */
@@ -677,14 +679,51 @@ export interface CommandBarItemProps {
      */
     onClick?: () => void;
 }
+/**
+ * Base properties of a CommandBarItem, rendered in the widget header.
+ */
+export interface CommandBarSearchItem extends CommandBarItemProps {
+    searchTerms: string;
+    onSearchTermsChange: (value: string) => void;
+}
 export interface CommandBarTabOptions {
+    /**
+     * The tabs to display in the widget command bar.
+     */
     tabs: CommandBarTab[];
+    /**
+     * Override the icon that is displayed in the overflow menu button.
+     */
+    overflowButtonIconName?: string;
+    /**
+     * Optional tooltip to display when hovering over the overflow menu button.
+     */
+    overflowButtonTooltip?: string;
+    /**
+     * Callback function that triggers when a new tab is selected.
+     */
     onTabSelect: (tabId: string) => void;
 }
 export interface CommandBarTab {
+    /**
+     * Unique id for this tab.
+     */
     id: string;
+    /**
+     * The text displayed in the tab. Leave this empty if you don't want to display any text.
+     */
     label: string;
+    /**
+     * Optional item count displayed after the label between parantheses. Example: Test label (5)
+     */
+    itemCount?: string | number;
+    /**
+     * Optional icon to display before the label.
+     */
     iconName?: string;
+    /**
+     * Optional tooltip to display when hovering over the tab.
+     */
     tooltip?: string;
 }
 /**

package/lib/types/index.js

@@ -40,6 +40,8 @@ var CommandBarItemType;
     CommandBarItemType["Icon"] = "icon";
     /** Renders the item as a clickable link */
     CommandBarItemType["Link"] = "link";
+    /** Renders the item as a search bar */
+    CommandBarItemType["SearchBar"] = "search-bar";
     /** Renders the item in the overflow menu */
     CommandBarItemType["Overflow"] = "overflow";
 })(CommandBarItemType || (exports.CommandBarItemType = CommandBarItemType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.10.2",
+    "version": "1.10.4",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -18,6 +18,9 @@
     "files": [
         "lib/**/*"
     ],
+    "overrides": {
+        "requirejs": "2.3.7"
+    },
     "dependencies": {
         "@microsoft/sp-http": "1.18.2",
         "@pnp/sp": "4.0.1"