@ichicraft/widgets-widget-base 1.8.8 → 1.8.10

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.10 - 2023-03-30
+
+-   Changed `openFilePicker` function to accept `options`, to support configuration of picker behavior
+
+## 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.

package/lib/types/index.d.ts

@@ -62,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,
@@ -69,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.
@@ -84,7 +95,7 @@ export interface WidgetContext {
         }) => void;
     };
     /**
-     * Metadata and functions in the context of a widget's definition. A widget definition is
+     * Metadata and functions in the context of a widget's variant (fka definition). A widget variant is
      * a widget that's been installed by an administrator from within the board administration.
      */
     definition: {
@@ -105,13 +116,12 @@ export interface WidgetContext {
     };
     /**
      * Metadata and functions in the context of a widget's manifest. A widget manifest contains
-     * all information of the originally installed widget. If multiple instances of the same widget 'type'
-     * exist in a widget board configuration, they share this manifest.
-     * We use the term 'definition' to distinguish each instance of a manifest.
+     * all information of the originally installed widget. Multiple `variants` of the same widget `manifest`
+     * can exist in a widget board configuration.
      */
     manifest: {
         /**
-         * Unique id of a widget 'type', also used in the widget manifest in the original script source manifest file.
+         * Unique id of a widget 'type', also used in the widget manifest config file in the original script source manifest file.
          * If this is a 'single instance widget', which means that no more than one instance of this
          * widget can be installed in the widget board, the id of the definition is the same as the id of the manifest.
          */
@@ -275,8 +285,10 @@ export interface WidgetContext {
     loadScript?: <TModule>(url: string, options?: any) => Promise<TModule>;
     /**
      * Functionality offered by the widget board to open a File Picker panel to select files.
+     * @param onFilePicked Function that's called when a file was picked. Returns the url of the picked file.
+     * @param options Options to change the behavior of the file picker
      */
-    openFilePicker?: (onFilePicked: (fileUrl: string) => void, onCancel?: () => void) => void;
+    openFilePicker?: (onFilePicked: (fileUrl: string) => void, options?: FilePickerOptions) => void;
     /**
      * Functionality offered by the widget board to open a url in an iframe dialog.
      * @param url The url to open in a dialog.
@@ -337,7 +349,7 @@ export interface WidgetManifestConfig {
      */
     manifestVersion: number;
     /**
-     * Unique id (Guid) to identify the widget
+     * Unique id to identify the widget
      */
     id: string;
     /**
@@ -518,6 +530,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
@@ -535,6 +551,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
@@ -566,5 +594,40 @@ export interface IFrameDialogOptions {
      */
     onDismissed?: () => void;
 }
+/**
+ * Options to pass to openFilePicker function
+ */
+export interface FilePickerOptions {
+    /**
+     * Array of file extensions that will be used to filter the files in the picker.
+     * @default ['.gif', '.jpg', '.jpeg', '.png']
+     */
+    extensions?: string[];
+    /**
+     * Maximum number of files to show in a folder
+     * @default 100
+     */
+    itemsCountQueryLimit?: number;
+    /**
+     * Whether or not to hide the organisational site files tab
+     * @default false
+     */
+    hideOrganisationalAssetTab?: boolean;
+    /**
+     * Whether or not to hide the site files tab
+     * @default false
+     */
+    hideSiteFilesTab?: boolean;
+    /**
+     * Whether or not to hide the upload tab
+     * @default false
+     */
+    hideLocalUploadTab?: boolean;
+    /**
+     * Function that's called when user closes file picker without picking a file
+     * @default undefined
+     */
+    onCancel?: () => void;
+}
 export declare type BoardType = 'shared' | 'personal';
 export declare type UserRole = 'administrator' | 'board-owner';

package/package.json

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