@ichicraft/widgets-widget-base 1.9.6 → 1.9.8

package/README.md

@@ -9,6 +9,19 @@ 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.9.8 - 2024-05-13
+
+-   Added `createDeepLink` property to the WidgetInstanceContext interface, to allow creating a deep link URL based on the current board and a widget instance.
+-   Added `setDeepLinkData` property to the WidgetInstanceContext interface, to allow setting deep link data related to a widget instance in the URL of the current page.
+-   Added `getDeepLinkData` property to the WidgetInstanceContext interface, to allow getting deep link data related to a widget instance from the URL of the current page.
+
+## 1.9.7 - 2024-04-19
+
+-   Added `hideSpHubNav` property to the IFrameDialogOptions interface, to allow hiding the Hub navigation on SharePoint sites.
+-   Added `hideSpSiteHeader` property to the IFrameDialogOptions interface, to allow hiding the site header on SharePoint sites.
+-   Added `showHistoryButtons` property to the IFrameDialogOptions interface, to render back and forward buttons, allowing the user to navigate the browser history.
+-   Added `showOpenInNewWindow` property to the IFrameDialogOptions interface, to render an 'open in new window' button, allowing the user to open the iframe url in a new browser window.
+
 ## 1.9.6 - 2024-04-19
 
 -   Changed `onRenderHeaderIcon` property of the IFrameDialogOptions interface, to work similarly to the widget render functions.

package/lib/types/index.d.ts

@@ -225,6 +225,19 @@ export interface WidgetInstanceContext {
      * The type of board this widget instance is added to.
      */
     boardType?: BoardType;
+    /**
+     * Creates a deep link URL based on the current board and this widget instance, combined with
+     * the provided data.
+     */
+    createDeepLink?: (data?: string) => void;
+    /**
+     * Sets deep link data related to this widget instance in the URL of the current page.
+     */
+    setDeepLinkData?: (data?: string) => void;
+    /**
+     * Gets all deep link data related to this widget instance from the URL of the current page.
+     */
+    getDeepLinkData?: () => string;
     /**
      * 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
@@ -640,6 +653,14 @@ export interface CommandBarLink extends CommandBarItemBase {
  * 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 {
+    /**
+     * Option to hide the Hub navigation on SharePoint sites.
+     */
+    hideSpHubNav?: boolean;
+    /**
+     * Option to hide the site header on SharePoint sites.
+     */
+    hideSpSiteHeader?: boolean;
     /**
      * Maximum width of the dialog. If it exceeds the window width, that width is used instead.
      */
@@ -656,6 +677,14 @@ export interface IFrameDialogOptions {
      * Minimum margin on the top- and bottom side of the dialog.
      */
     marginVertical?: number;
+    /**
+     * Show 'back' and 'forward' buttons in the dialog header, to allow navigating through the browser history.
+     */
+    showHistoryButtons?: boolean;
+    /**
+     * Show an 'open in new window' button in the dialog header.
+     */
+    showOpenInNewWindow?: boolean;
     /**
      * Title displayed in the dialog header.
      */

package/package.json

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