@ichicraft/widgets-widget-base 1.8.5 → 1.8.6

package/README.md

@@ -9,6 +9,12 @@ 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.6 - 2022-12-08
+
+-   Added `boardType` property to the `instance` object of the `WidgetContext` interface, to inform widgets of the type of their board.
+-   Added `allowedBoardTypes` property to the `definition` object of the `WidgetContext` interface, to inform widget variants of the types of boards it is allowed to be added to.
+-   Added new exported `BoardType` type.
+
 ## 1.8.5 - 2022-09-30
 
 -   Added `setWidgetTitleSuffix()` function to the `instance` object of the `WidgetContext` interface, to support appending the title of the widget with additional text.

package/lib/types/index.d.ts

@@ -19,6 +19,10 @@ export interface WidgetContext {
          * Optional configuration data that contains user settings of a specific widget instance
          */
         data?: string;
+        /**
+         * The type of board this widget instance is added to.
+         */
+        boardType?: BoardType;
         /**
          * Call this function from within a widget instance to publish a notification to the
          * notitication box on top of the widget board. It should provide information for this specific
@@ -97,6 +101,10 @@ export interface WidgetContext {
          * Optional configuration data that contains board-wide settings of a specific widget instance
          */
         data?: string;
+        /**
+         * A list of board types applicable for this widget variant.
+         */
+        allowedBoardTypes?: BoardType[];
     };
     /**
      * Metadata and functions in the context of a widget's manifest. A widget manifest contains
@@ -557,3 +565,4 @@ export interface IFrameDialogOptions {
      */
     onDismissed?: () => void;
 }
+export declare type BoardType = 'shared' | 'personal';

package/package.json

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