@ichicraft/widgets-widget-base 1.9.8 → 1.9.10

package/README.md

@@ -9,6 +9,19 @@ 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.9.10 - 2024-06-04
+
+-   Renamed `CustomCommandBarItemProps` interface to `CommandBarItemProps`.
+-   Merged `CommandBarIcon`, `CommandBarLink` and `CommandBarItemBase` interfaces into the `CommandBarItemProps` interface, to simplify adding custom command bar items.
+-   Added `Overflow` type to `CommandBarItemType` enum, to allow rendering an item inside the overflow menu.
+-   Added `highlighted` property to the `CommandBarItemProps` interface, to allow rendering an item as if it is being hovered.
+-   Added `cursor` property to the `CommandBarItemProps` interface, to allow a different cursor when hovering over an item.
+-   Added `disabled` property to the `CommandBarItemProps` interface, to allow rendering an item in a disabled state.
+
+## 1.9.9 - 2024-05-14
+
+-   Changed return type of `createDeepLink` function of the WidgetInstanceContext interface from `void` to `string`.
+
 ## 1.9.8 - 2024-05-13
 
 -   Added `createDeepLink` property to the WidgetInstanceContext interface, to allow creating a deep link URL based on the current board and a widget instance.

package/lib/types/index.d.ts

@@ -228,8 +228,9 @@ export interface WidgetInstanceContext {
     /**
      * Creates a deep link URL based on the current board and this widget instance, combined with
      * the provided data.
+     * @returns The deep link URL.
      */
-    createDeepLink?: (data?: string) => void;
+    createDeepLink?: (data?: string) => string;
     /**
      * Sets deep link data related to this widget instance in the URL of the current page.
      */
@@ -285,13 +286,13 @@ export interface WidgetInstanceContext {
      * an icon button, depending on the presence of the onClick property. To remove the items,
      * use the [unregisterCommandBarItems] function.
      */
-    registerCustomCommandBarItems?: (props: CustomCommandBarItemProps[]) => void;
+    registerCustomCommandBarItems?: (props: CommandBarItemProps[]) => 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,
      * use the [unregisterCommandBarItem] function.
      */
-    registerCustomCommandBarItem?: (props: CustomCommandBarItemProps) => void;
+    registerCustomCommandBarItem?: (props: CommandBarItemProps) => void;
     /**
      * Removes all registered custom command bar items.
      */
@@ -572,28 +573,25 @@ export declare enum CustomCommandBarItemSeverity {
  * Tells how to render the command bar item, e.g. as an icon button or as a link.
  */
 export declare enum CommandBarItemType {
-    /** Normal severity, displays just like all the other command bar items */
+    /** Renders the item as an Icon */
     Icon = "icon",
-    /** Warning severity, displays the item with a more noticable warning color */
-    Link = "link"
+    /** Renders the item as a clickable link */
+    Link = "link",
+    /** Renders the item in the overflow menu */
+    Overflow = "overflow"
 }
 /**
- * Properties to pass to the registerCommandBarItems function, resulting in the
- * rendering of a command bar item.
- */
-export type CustomCommandBarItemProps = CommandBarIcon | CommandBarLink;
-/**
- * Base properties of a custom CommandBarItem.
+ * Base properties of a CommandBarItem, rendered in the widget header.
  */
-export interface CommandBarItemBase {
+export interface CommandBarItemProps {
     /**
      * Optional identifier for the icon.
      */
     id?: string;
     /**
-     * Type of item, (e.g. 'icon' or 'link')
+     * Optional type of item, (e.g. 'icon' or 'link'). When not specified, the item is rendered as an icon.
      */
-    itemType: CommandBarItemType;
+    itemType?: CommandBarItemType;
     /**
      * Optional content to show as a tooltip above the item.
      */
@@ -606,17 +604,28 @@ export interface CommandBarItemBase {
      * Optionally tells the Widget Header that this item should always be visible, even when not hovering.
      */
     pinned?: boolean;
-}
-/**
- * Properties to render a custom CommandBarItem either as a single Icon or an Icon Button.
- */
-export interface CommandBarIcon extends CommandBarItemBase {
-    itemType: CommandBarItemType.Icon;
     /**
-     * Name of the icon, as specified and available in Fluent UI Iconography:
+     * Optionally tells the Widget Header that this item should always be rendered as if it is being hovered.
+     */
+    highlighted?: boolean;
+    /**
+     * Optionally override the cursor when hovering over the item.
+     */
+    cursor?: string;
+    /**
+     * Optionally tells the Widget Header that this item should be rendered in a disabled state.
+     */
+    disabled?: boolean;
+    /**
+     * Name of the icon displayed when rendered as an Icon, or in the overflow menu.
+     * See the available icon names in Fluent UI Iconography:
      * https://developer.microsoft.com/en-us/fluentui#/styles/web/icons
      */
     iconName: string;
+    /**
+     * Displayed label when rendered as a link, or in the overflow menu.
+     */
+    label: string;
     /**
      * Optionally display a red notification icon badge in the top-right corner of the button.
      */
@@ -635,20 +644,6 @@ export interface CommandBarIcon extends CommandBarItemBase {
      */
     onClick?: () => void;
 }
-/**
- * Properties to render a custom CommandBarItem as a Link Button.
- */
-export interface CommandBarLink extends CommandBarItemBase {
-    itemType: CommandBarItemType.Link;
-    /**
-     * Required label to display the clickable link.
-     */
-    label: string;
-    /**
-     * Required onClick event, which is triggered on user click.
-     */
-    onClick: () => void;
-}
 /**
  * Options to pass to the openIFrameDialog function. Use this to configure how the dialog is rendered, and to handle events (e.g. onDismissed)
  */

package/lib/types/index.js

@@ -36,8 +36,10 @@ var CustomCommandBarItemSeverity;
  */
 var CommandBarItemType;
 (function (CommandBarItemType) {
-    /** Normal severity, displays just like all the other command bar items */
+    /** Renders the item as an Icon */
     CommandBarItemType["Icon"] = "icon";
-    /** Warning severity, displays the item with a more noticable warning color */
+    /** Renders the item as a clickable link */
     CommandBarItemType["Link"] = "link";
+    /** 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.9.8",
+    "version": "1.9.10",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",