@ichicraft/widgets-widget-base 1.10.4 → 1.10.6

package/README.md

@@ -9,6 +9,14 @@ 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.6 - 2024-08-19
+
+-   Added `userDisplayName` property to the `WidgetContext` interface, to allow using the currently signed-in user's display name in widgets.
+
+## 1.10.5 - 2024-08-07
+
+-   Added `onSearch` property to the `CommandBarSearchItem` interface, to allow executing a callback when the user presses enter in the search box.
+
 ## 1.10.4 - 2024-07-23
 
 -   Added `SearchBar` value to the `CommandBarItemType` enum, to allow rendering a command bar item as a search bar.

package/lib/types/index.d.ts

@@ -71,7 +71,14 @@ export interface WidgetContext {
      */
     siteUrl: string;
     /**
-     * User name of the currently signed in user
+     * Display name of the currently signed in user
+     *
+     * @remarks
+     * Example: `"Alex Wilber"`
+     */
+    userDisplayName: string;
+    /**
+     * User principal name of the currently signed in user
      */
     userName: string;
     /**
@@ -684,7 +691,8 @@ export interface CommandBarItemProps {
  */
 export interface CommandBarSearchItem extends CommandBarItemProps {
     searchTerms: string;
-    onSearchTermsChange: (value: string) => void;
+    onChange?: (value: string) => void;
+    onSearch?: (value: string) => void;
 }
 export interface CommandBarTabOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.10.4",
+    "version": "1.10.6",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",