@ichicraft/widgets-widget-base 1.8.3 → 1.8.5

package/README.md

@@ -3,77 +3,119 @@ This package supports development of widgets built using the Widget Development
 _This package is part of the Widget Development Kit, which is a collection of NPM packages that empower developers to create widgets for Ichicraft Boards._
 
 # Changelog
+
 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.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.
+-   Added `setWidgetSubtitle()` function to the `instance` object of the `WidgetContext` interface, to support overriding the subtitle of the widget.
+-   Added `setUserConfigButtonVisibilty()` function to the `instance` object of the `WidgetContext` interface, to support hiding the settings button from the widget header.
+-   Fixed spelling of `setWidgetHeaderVisibilty()` function. The function is now called `setWidgetHeaderVisibility()`.
+
+## 1.8.4 - 2022-09-05
+
+-   Added `openIFrameDialog()` function to the `WidgetContext` interface. This has the same functionality as the `openUrlInDialog()` function of the `instance` object, but adds more control over the dimensions of the dialog. The function `openUrlInDialog()` is now deprecated.
+
 ## 1.8.3 - 2022-08-16
-* Added `openFilePicker` property to the `WidgetContext` interface to support file selection from within a widget.
+
+-   Added `openFilePicker()` function 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.
+
+-   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.
+
+-   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.
+
+-   Added `setWidgetHeaderVisibilty()` function to the `instance` object of the `WidgetContext` interface, allowing widgets to render in full height.
 
 ## 1.7.9 - 2022-01-20
-* Added `userAccountCreated` date/time to the `WidgetContext` interface.
+
+-   Added `userAccountCreated` date/time to the `WidgetContext` interface.
 
 ## 1.7.8 - 2022-01-18
+
 ### Changed
-* Added `initiateWidgetDeletion()` function to the `WidgetContext` interface.
+
+-   Added `initiateWidgetDeletion()` function to the `WidgetContext` interface.
 
 ## 1.7.7 - 2022-01-14
+
 ### Changed
-* Added `tenantId` property to the `WidgetContext` interface.
+
+-   Added `tenantId` property to the `WidgetContext` interface.
 
 ## 1.7.6 - 2021-11-04
+
 ### Changed
-* Added `theme` property to the `WidgetContext` interface to give access to currently applied theme.
+
+-   Added `theme` property to the `WidgetContext` interface to give access to currently applied theme.
 
 ## 1.7.5 - 2021-10-26
+
 ### Changed
-* Added `userSecurityGroups` and `userSharePointGroups` properties to the `WidgetContext` interface to inform widgets of SharePoint and security group memberships of the current user.
+
+-   Added `userSecurityGroups` and `userSharePointGroups` properties to the `WidgetContext` interface to inform widgets of SharePoint and security group memberships of the current user.
 
 ## 1.7.4 - 2021-10-20
+
 ### Changed
-* Added `contentLanguages` property to the `WidgetContext` interface to inform widgets of the available content languages as configured in Ichicraft Boards.
+
+-   Added `contentLanguages` property to the `WidgetContext` interface to inform widgets of the available content languages as configured in Ichicraft Boards.
 
 ## 1.7.3 - 2021-10-04
+
 ### Changed
-* Added `manifestVersion` property to the `WidgetManifestConfig` interface to support multiple versions of the manifest. Current version is 2 which introduced this and the `externals` property.
-* Added `externals` property to the `WidgetManifestConfig` interface to support libraries that can be loaded separately from the widget bundle. This reduces widget bundle size and improves overal performance of Ichicraft Boards.
+
+-   Added `manifestVersion` property to the `WidgetManifestConfig` interface to support multiple versions of the manifest. Current version is 2 which introduced this and the `externals` property.
+-   Added `externals` property to the `WidgetManifestConfig` interface to support libraries that can be loaded separately from the widget bundle. This reduces widget bundle size and improves overal performance of Ichicraft Boards.
 
 ## 1.6.1 - 2021-02-18
+
 ### Changed
-* Added `userEmail` property to the `WidgetContext` interface to provide current user's email address to widgets.
+
+-   Added `userEmail` property to the `WidgetContext` interface to provide current user's email address to widgets.
 
 ## 1.5.0 - 2021-02-16
+
 ### Changed
-* Added `teamsSdk` property to the `WidgetContext` interface to allow interaction with Teams in case widget board is running in Teams client. Will be `undefined` if running in SharePoint.
+
+-   Added `teamsSdk` property to the `WidgetContext` interface to allow interaction with Teams in case widget board is running in Teams client. Will be `undefined` if running in SharePoint.
 
 ## 1.4.0 - 2021-01-25
+
 ### Changed
-* Added several properties to the `WidgetContext` interface to identify the context in which the widget is shown (e.g. Team Browser hosted)
+
+-   Added several properties to the `WidgetContext` interface to identify the context in which the widget is shown (e.g. Team Browser hosted)
 
 ## 1.3.0 - 2021-01-15
+
 ### Changed
-* `registerCustomCommandBarItem()` is added to the `WidgetContext` interface as a function to call from within a widget instance to render an additional command bar item in the widget header.
-* `unregisterCustomCommandBarItem()` is added to the `WidgetContext` interface as a function to call from within a widget instance to remove a previously added command bar item from the widget header.
+
+-   `registerCustomCommandBarItem()` is added to the `WidgetContext` interface as a function to call from within a widget instance to render an additional command bar item in the widget header.
+-   `unregisterCustomCommandBarItem()` is added to the `WidgetContext` interface as a function to call from within a widget instance to remove a previously added command bar item from the widget header.
 
 ## 1.2.0 - 2021-01-15
+
 ### Changed
-* `loadScript()` is added to the `WidgetContext` interface as a function to call from within a widget in case an external script needs to be loaded. This allows the widget board to load external javascript.
+
+-   `loadScript()` is added to the `WidgetContext` interface as a function to call from within a widget in case an external script needs to be loaded. This allows the widget board to load external javascript.
 
 ## 1.1.0 - 2021-01-11
+
 ### Changed
-* `handleFatalError()` is added to the `WidgetContext` interface as a function to call from within a widget in case of an unhandled/unresolvable error. This allows the widget board to handle this situation gracefully.
-* **deps:** removed dependency ajv
+
+-   `handleFatalError()` is added to the `WidgetContext` interface as a function to call from within a widget in case of an unhandled/unresolvable error. This allows the widget board to handle this situation gracefully.
+-   **deps:** removed dependency ajv
 
 ## <= 1.0.5 - 2020-12-07
-No changelog was maintained for the earlier versions.
+
+No changelog was maintained for the earlier versions.

package/lib/types/index.d.ts

@@ -38,19 +38,27 @@ export interface WidgetContext {
          */
         initiateWidgetDeletion?: () => void;
         /**
-         * Functionality offered by the widget board to open a url in an iframe dialog.
+         * Functionality offered by the widget board to change the title of the widget.
          */
-        openUrlInDialog?: (url: string, onDismissed?: () => void) => void;
+        setWidgetTitle?: (title: string) => void;
         /**
-         * Functionality offered by the widget board to change the title of the widget
+         * Functionality offered by the widget board to append the title of the widget with additional text.
          */
-        setWidgetTitle?: (title: string) => void;
+        setWidgetTitleSuffix?: (suffix: string) => void;
+        /**
+         * Functionality offered by the widget board to change the subtitle of the widget.
+         */
+        setWidgetSubtitle?: (subtitle: string) => void;
+        /**
+         * Show or hide the header of the widget, allowing widgets to take control of full widget real estate.
+         */
+        setWidgetHeaderVisibility?: (visible: boolean) => void;
         /**
-         * Show or hide the header of the widget, allowing widgets to take control of full widget real estate
+         * Show or hide the settings button of the widget.
          */
-        setWidgetHeaderVisibilty?: (visible: boolean) => void;
+        setUserConfigButtonVisibility?: (visible: boolean) => void;
         /**
-         * Optional callback to handle the click event of the widget title
+         * Optional callback to handle the click event of the widget title.
          */
         onWidgetTitleClicked?: () => void;
         /**
@@ -260,6 +268,12 @@ export interface WidgetContext {
      * Functionality offered by the widget board to open a File Picker panel to select files.
      */
     openFilePicker?: (onFilePicked: (fileUrl: string) => void, onCancel?: () => void) => void;
+    /**
+     * Functionality offered by the widget board to open a url in an iframe dialog.
+     * @param url The url to open in a dialog.
+     * @param options Options to configure the dialog (e.g. size, margin, callbacks, ...)
+     */
+    openIFrameDialog?: (url: string, options?: IFrameDialogOptions) => void;
     /**
      * Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.
      */
@@ -518,3 +532,28 @@ export interface CustomCommandBarItemProps {
      */
     onClick?: () => void;
 }
+/**
+ * Options to pass to the openIFrameDialog function. Use this to configure how the dialog is rendered, and to handle events (e.g. onDismissed)
+ */
+export interface IFrameDialogOptions {
+    /**
+     * Maximum width of the dialog. If it exceeds the window width, that width is used instead.
+     */
+    maxWidth?: number;
+    /**
+     * Maximum height of the dialog. If it exceeds the window height, that height is used instead.
+     */
+    maxHeight?: number;
+    /**
+     * Minimum margin on the left- and right side of the dialog.
+     */
+    marginHorizontal?: number;
+    /**
+     * Minimum margin on the top- and bottom side of the dialog.
+     */
+    marginVertical?: number;
+    /**
+     * This event is triggered when the iFrame dialog is dismissed by the user.
+     */
+    onDismissed?: () => void;
+}

package/package.json

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