@ichicraft/widgets-widget-base 1.9.5 → 1.9.7

package/README.md

@@ -9,6 +9,17 @@ 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.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.
+
 ## 1.9.5 - 2024-04-18
 
 -   Added `title` property to the IFrameDialogOptions interface, to allow rendering a title in the dialog header.

package/lib/types/index.d.ts

@@ -640,6 +640,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 +664,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.
      */
@@ -675,7 +691,7 @@ export interface IFrameDialogOptions {
     /**
      * Renders an icon on the left side of the dialog header.
      */
-    onRenderHeaderIcon?: () => Element;
+    onRenderHeaderIcon?: (domElement: HTMLDivElement) => void;
 }
 /**
  * Options to pass to openFilePicker function

package/package.json

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