@ichicraft/widgets-widget-base 1.10.7 → 1.11.0

package/README.md

@@ -9,6 +9,16 @@ 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.11.0 - 2024-10-17
+
+-   Added `renderBuddy` function to the `BaseWidget` class, to support rendering widgets as a buddy.
+-   Added `buddy` property of type `WidgetBuddyContext` to the `WidgetContext` interface, to support utility functions specifically for a widget buddy.
+-   Added `setBadgeProperties` function to the `WidgetBuddyContext` interface, to allow rendering a badge on top of the buddy.
+
+## 1.10.8 - 2024-10-15
+
+-   Added `buddybar` to the `BoardType` type, to support widgets that run in the scope of the upcoming buddy bar feature
+
 ## 1.10.7 - 2024-08-20
 
 -   Replaced `onInit` function with a new asynchronous `init` function in the `BaseWidget` class, to allow waiting until initialization is complete.

package/lib/BaseWidget.d.ts

@@ -4,6 +4,10 @@ export default abstract class BaseWidget {
     constructor(context: WidgetContext);
     abstract init(): Promise<void>;
     abstract render(domElement: HTMLDivElement): void;
+    /** Render function for the widget buddy component.
+     *  @returns Whether or not the buddy is using custom rendering.
+     */
+    renderBuddy?(domElement: HTMLDivElement): boolean;
     verifyPersistedUserConfiguration?(config: string): Promise<boolean>;
     renderUserConfigurationForm?(domElement: HTMLDivElement): void;
     validateUserConfigurationForm?(): ValidationResult;

package/lib/types/index.d.ts

@@ -11,6 +11,12 @@ export interface WidgetContext {
      * unique ID and possibly configuration data if the widget is configurable by the user
      */
     instance: WidgetInstanceContext;
+    /**
+     * Metadata and functions in the context of a widget boddy. A widget buddy
+     * is a single and specific widget that a user has on his/her board. It has its own
+     * unique ID and possibly configuration data if the widget is configurable by the user
+     */
+    buddy: WidgetBuddyContext;
     /**
      * 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.
@@ -349,6 +355,12 @@ export interface WidgetInstanceContext {
         [key: string]: string;
     }) => void;
 }
+export interface WidgetBuddyContext {
+    /**
+     * Allows setting the badge properties of the buddy, e.g. its visibility, count or color.
+     */
+    setBadgeProperties?: (props: Partial<BadgeProperties>) => void;
+}
 /**
  * Widget variant context providing metadata and functionality offered by the widget board. A widget variant is
  * a widget that's been installed by an administrator from within the board administration.
@@ -840,8 +852,13 @@ export interface FilePickerFileProps {
      */
     siteId: string;
 }
-export type BoardType = 'shared' | 'personal';
+export type BoardType = 'shared' | 'personal' | 'buddybar';
 export type UserRole = 'administrator' | 'board-owner' | 'widget-administrator';
 export interface ExportData {
     data: object[];
 }
+export interface BadgeProperties {
+    isVisible?: boolean;
+    count?: number;
+    color?: string;
+}

package/package.json

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