@ichicraft/widgets-widget-base 1.8.4 → 1.8.5

package/README.md

@@ -9,6 +9,13 @@ 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.

package/lib/types/index.d.ts

@@ -38,19 +38,27 @@ export interface WidgetContext {
          */
         initiateWidgetDeletion?: () => void;
         /**
-         * @deprecated 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;
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.8.4",
+    "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",