@ichicraft/widgets-widget-base 1.10.0 → 1.10.2

package/README.md

@@ -9,6 +9,17 @@ 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.2 - 2024-07-19
+
+-   Added `registerTabs` function to the `WidgetInstanceContext` interface, to allow rendering of tabs in the widget header.
+-   Added `setSelectedTab` function to the `WidgetInstanceContext` interface, to allow setting the current selected tab in the widget header.
+-   Added `CommandBarTab` interface.
+-   Added `CommandBarTabOptions` interface.
+
+## 1.10.1 - 2024-07-08
+
+-   Added `widget-administrator` role to the `UserRole` type.
+
 ## 1.10.0 - 2024-06-25
 
 -   Added optional `updateDataAccess()` function to the `BaseWidget` class, used to update access to widget-specific data.

package/lib/types/index.d.ts

@@ -323,6 +323,14 @@ export interface WidgetInstanceContext {
      * If no id was specified, it removes all items.
      */
     unregisterCustomCommandBarItem?: (id?: string) => void;
+    /**
+     * Allows registration of tabs (pivots) in the widget header.
+     */
+    registerTabs?: (options: CommandBarTabOptions) => void;
+    /**
+     * Allows setting the current selected tab in the widget header.
+     */
+    setSelectedTab?: (tabId: 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.
@@ -669,6 +677,16 @@ export interface CommandBarItemProps {
      */
     onClick?: () => void;
 }
+export interface CommandBarTabOptions {
+    tabs: CommandBarTab[];
+    onTabSelect: (tabId: string) => void;
+}
+export interface CommandBarTab {
+    id: string;
+    label: string;
+    iconName?: string;
+    tooltip?: string;
+}
 /**
  * Options to pass to the openIFrameDialog function. Use this to configure how the dialog is rendered, and to handle events (e.g. onDismissed)
  */
@@ -776,7 +794,7 @@ export interface FilePickerFileProps {
     siteId: string;
 }
 export type BoardType = 'shared' | 'personal';
-export type UserRole = 'administrator' | 'board-owner';
+export type UserRole = 'administrator' | 'board-owner' | 'widget-administrator';
 export interface ExportData {
     data: object[];
 }

package/package.json

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