@ichicraft/widgets-widget-base 1.8.0 → 1.8.3

package/README.md

@@ -8,6 +8,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.8.3 - 2022-08-16
+* Added `openFilePicker` property to the `WidgetContext` interface to support file selection from within a widget.
+
+## 1.8.2 - 2022-07-06
+* Added `subtitle` property to the `WidgetResource` interface.
+
+## 1.8.1 - 2022-06-17
+* Added new section `analytics` to `WidgetManifestConfig` interface to allow definition of time-based events that can be raised by a widget.
+* Added `raiseEvent(...)` to the `instance` object of the `WidgetContent` interface, allowing widgets to raise an event.
+
 ## 1.7.11 - 2022-03-23
 * Added `setWidgetHeaderVisibilty()` function to the `instance` object of the `WidgetContext` interface, allowing widgets to render in full height.
 

package/lib/types/index.d.ts

@@ -249,13 +249,17 @@ export interface WidgetContext {
     /**
      * Call this function from within one of the applicable render methods in case of an unresolvable error.
      * The widgetboard will render a 'disrupted' message and in case of an error in widget rendering it
-     * offers the user the option to delete the widget from the board
+     * offers the user the option to delete the widget from the board.
      */
     handleFatalError?: () => void;
     /**
-     * Functionality offered by the widget board to load a script using SPComponentLoader
+     * Functionality offered by the widget board to load a script using SPComponentLoader.
      */
     loadScript?: <TModule>(url: string, options?: any) => Promise<TModule>;
+    /**
+     * Functionality offered by the widget board to open a File Picker panel to select files.
+     */
+    openFilePicker?: (onFilePicked: (fileUrl: string) => void, onCancel?: () => void) => void;
     /**
      * Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.
      */
@@ -282,6 +286,7 @@ export interface WidgetImages {
 export interface WidgetResource {
     lang: number;
     title: string;
+    subtitle?: string;
     shortDescription: string;
     instructions: string;
     images: WidgetImages;

package/package.json

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