@sigmacomputing/react-embed-sdk 0.2.3 → 0.2.4

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent } from '@sigmacomputing/embed-sdk';
+import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent } from '@sigmacomputing/embed-sdk';
 export * from '@sigmacomputing/embed-sdk';
 import * as react from 'react';
 
@@ -30,6 +30,29 @@ declare function useSigmaIframe(): {
     variables: Record<string, string> | null | undefined;
 };
 
+/**
+ *
+ * A hook that returns the height of the page in the iframe.
+ * This HAS to be used with the responsive_height option in the embed.
+ *
+ * @example
+ * ```
+ * function MyEmbed() {
+ *  const { iframeRef } = useSigmaIframe();
+ * const height = usePageHeight(iframeRef);
+ *  return (
+ *   <>
+ *     <iframe
+ *       style={{ height }}
+ *       ref={iframeRef}
+ *       src="https://app.sigmacomputing.com/embed"
+ *     />
+ *   </>
+ * );
+ * }
+ */
+declare function usePageHeight(iframeRef: React.RefObject<HTMLIFrameElement>): number | undefined;
+
 /**
  * Listen for a workbook loaded event, and execute the given callback when it occurs.
  *
@@ -103,11 +126,11 @@ declare function useWorkbookPageSelectedNode(iframeRef: React.RefObject<HTMLIFra
 declare function useWorkbookPivotTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void): void;
 declare function useWorkbookChartValueSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void): void;
 declare function useWorkbookCurrentVariables(iframeRef: React.RefObject<HTMLIFrameElement>, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void): void;
-declare function useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkCreateEvent) => void): void;
+declare function useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void): void;
 declare function useWorkbookChartError(iframeRef: React.RefObject<HTMLIFrameElement>, onChartError: (event: WorkbookChartErrorEvent) => void): void;
 declare function useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onExploreKeyChange: (event: WorkbookExploreKeyOnChangeEvent) => void): void;
 declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
 
-export { useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished };
+export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent } from '@sigmacomputing/embed-sdk';
+import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent } from '@sigmacomputing/embed-sdk';
 export * from '@sigmacomputing/embed-sdk';
 import * as react from 'react';
 
@@ -30,6 +30,29 @@ declare function useSigmaIframe(): {
     variables: Record<string, string> | null | undefined;
 };
 
+/**
+ *
+ * A hook that returns the height of the page in the iframe.
+ * This HAS to be used with the responsive_height option in the embed.
+ *
+ * @example
+ * ```
+ * function MyEmbed() {
+ *  const { iframeRef } = useSigmaIframe();
+ * const height = usePageHeight(iframeRef);
+ *  return (
+ *   <>
+ *     <iframe
+ *       style={{ height }}
+ *       ref={iframeRef}
+ *       src="https://app.sigmacomputing.com/embed"
+ *     />
+ *   </>
+ * );
+ * }
+ */
+declare function usePageHeight(iframeRef: React.RefObject<HTMLIFrameElement>): number | undefined;
+
 /**
  * Listen for a workbook loaded event, and execute the given callback when it occurs.
  *
@@ -103,11 +126,11 @@ declare function useWorkbookPageSelectedNode(iframeRef: React.RefObject<HTMLIFra
 declare function useWorkbookPivotTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void): void;
 declare function useWorkbookChartValueSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void): void;
 declare function useWorkbookCurrentVariables(iframeRef: React.RefObject<HTMLIFrameElement>, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void): void;
-declare function useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkCreateEvent) => void): void;
+declare function useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void): void;
 declare function useWorkbookChartError(iframeRef: React.RefObject<HTMLIFrameElement>, onChartError: (event: WorkbookChartErrorEvent) => void): void;
 declare function useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onExploreKeyChange: (event: WorkbookExploreKeyOnChangeEvent) => void): void;
 declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
 
-export { useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished };
+export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  usePageHeight: () => usePageHeight,
   useSigmaIframe: () => useSigmaIframe,
   useTableCellSelect: () => useTableCellSelect,
   useUrlOnChange: () => useUrlOnChange,
@@ -315,8 +316,21 @@ function useSigmaIframe() {
   useWorkbookError(iframeRef, errorCallback);
   return { iframeRef, loading, error, variables };
 }
+
+// src/use-page-height.ts
+var import_react3 = require("react");
+function usePageHeight(iframeRef) {
+  const [height, setHeight] = (0, import_react3.useState)(void 0);
+  useWorkbookPageHeight(iframeRef, (event) => {
+    if (!iframeRef.current)
+      return;
+    setHeight(event.pageHeight);
+  });
+  return height;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  usePageHeight,
   useSigmaIframe,
   useTableCellSelect,
   useUrlOnChange,

package/dist/index.mjs

@@ -290,7 +290,20 @@ function useSigmaIframe() {
   useWorkbookError(iframeRef, errorCallback);
   return { iframeRef, loading, error, variables };
 }
+
+// src/use-page-height.ts
+import { useState as useState2 } from "react";
+function usePageHeight(iframeRef) {
+  const [height, setHeight] = useState2(void 0);
+  useWorkbookPageHeight(iframeRef, (event) => {
+    if (!iframeRef.current)
+      return;
+    setHeight(event.pageHeight);
+  });
+  return height;
+}
 export {
+  usePageHeight,
   useSigmaIframe,
   useTableCellSelect,
   useUrlOnChange,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/react-embed-sdk",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "React JavaScript SDK to interact with Sigma Computing's Embed API",
   "author": "sigmacomputing",
   "license": "ISC",
@@ -23,7 +23,7 @@
     "@sigmacomputing/typescript-config": "0.0.0"
   },
   "dependencies": {
-    "@sigmacomputing/embed-sdk": "0.2.3"
+    "@sigmacomputing/embed-sdk": "0.2.4"
   },
   "scripts": {
     "prepublish": "pnpm build",