@iframe-resizer/react 5.0.0-beta.4 → 5.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 # @iframe-resizer/react
 
-This package is part of __iframe-resizer__, a library that enables the automatic resizing of the height and width of both same and cross domain iframes to fit their contained content. It also provides a range of features to address the most common issues with using iframes.
+This package is part of __[iframe-resizer](https://iframe-resizer.com)__, a library that enables the automatic resizing of the height and width of both same and cross domain iframes to fit their contained content. It also provides a range of features to address the most common issues with using iframes.
 
 __See [iframe-resizer.com](https://iframe-resizer.com) for details.__
 
@@ -22,4 +22,4 @@ yarn add @iframe-resizer/react
 
 ---
 
-_iframe-resizer version 5.0.0-beta.4 2024-05-10 - 07:48:19.523Z_
+_iframe-resizer version 5.0.0 2024-05-19 - 19:04:30.239Z_

package/iframe-resizer.react.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @fileoverview Type definitions for @iframe-resizer/react
+ *
+ * I'm not a TypeScript dev, so please feel free to submit PRs to improve this file.
+ */
+
 declare module '@iframe-resizer/react' {
   import * as React from 'react'
 
@@ -5,14 +11,16 @@ declare module '@iframe-resizer/react' {
     type IFrameObject = {
       moveToAnchor: (anchor: string) => void
       resize: () => void
-      sendMessage: (message: any, targetOrigin?: string) => void
+      sendMessage: (message: string, targetOrigin?: string) => void
     }
+
     interface IFrameComponent extends HTMLIFrameElement {
       iFrameResizer: IFrameObject
     }
 
-    type IFrameForwardRef = Omit<IFrameObject, 'close' | 'removeListeners'> & {
-      getIframeElement: () => IFrameComponent
+    type IFrameForwardRef = Omit<IFrameObject, 'close' | 'disconnect'> & {
+      getElement: () => IFrameComponent
+      getRef: () => any
     }
 
     type IframeProps = React.DetailedHTMLProps<
@@ -29,9 +37,7 @@ declare module '@iframe-resizer/react' {
       forwardRef?: any
       inPageLinks?: boolean
       license: string
-      enablePublicMethods?: boolean
-      offsetHeight?: number
-      offsetWidth?: number
+      offset?: number
       scrolling?: boolean | 'omit'
       tolerance?: number
       warningTimeout?: number
@@ -57,5 +63,6 @@ declare module '@iframe-resizer/react' {
   function IframeResizer(
     props: IframeResizer.IframeResizerProps,
   ): React.ReactElement
+
   export = IframeResizer
 }

package/index.cjs.js

@@ -1,7 +1,7 @@
 /*!
  *  @preserve
  *  
- *  @module     iframe-resizer/react 5.0.0-beta.4 (cjs) - 2024-05-10
+ *  @module     iframe-resizer/react 5.0.0 (cjs) - 2024-05-19
  *
  *  @license    GPL-3.0 for non-commercial use only.
  *              For commercial use, you must purchase a license from
@@ -17,4 +17,4 @@
  */
 
 
-"use strict";const e=require("@babel/runtime/helpers/extends"),r=require("@babel/runtime/helpers/defineProperty"),n=require("@babel/runtime/helpers/objectWithoutProperties"),t=require("@iframe-resizer/core"),o=require("react"),i=require("warning");var c=["license","bodyBackground","bodyMargin","bodyPadding","checkOrigin","inPageLinks","offset","offsetHeight","offsetWidth","scrolling","warningTimeout","tolerance","onClosed","onReady","onMessage","onResized"];var u=["title","forwardRef"];function s(e,r){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);r&&(t=t.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),n.push.apply(n,t)}return n}function a(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?s(Object(t),!0).forEach((function(n){r(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):s(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}module.exports=function(r){var s=r.title,f=void 0===s?"iframe":s,l=r.forwardRef,d=n(r,u),g=function(e){return e.license,e.bodyBackground,e.bodyMargin,e.bodyPadding,e.checkOrigin,e.inPageLinks,e.offset,e.offsetHeight,e.offsetWidth,e.scrolling,e.warningTimeout,e.tolerance,e.onClosed,e.onReady,e.onMessage,e.onResized,n(e,c)}(d),b=o.useRef(null),m=function(){var e;return i(!b.current,"[iframeSizerReact][".concat(null==b||null===(e=b.current)||void 0===e?void 0:e.id,"] Close event ignored, to remove the iframe update your React component")),!b.current};return o.useEffect((function(){var e=b.current,r=t(a(a({},d),{},{onClose:m}))(e);return function(){return null==r?void 0:r.disconnect()}}),[]),o.useImperativeHandle(l,(function(){return{getIframeElement:function(){return b.current},resize:function(){return b.current.iframeResizer.resize()},moveToAnchor:function(e){return b.current.iframeResizer.moveToAnchor(e)},sendMessage:function(e,r){b.current.iframeResizer.sendMessage(e,r)}}})),o.createElement("iframe",e({title:f},g,{ref:b}))};
+"use strict";const e=require("@babel/runtime/helpers/extends"),r=require("@babel/runtime/helpers/defineProperty"),n=require("@babel/runtime/helpers/objectWithoutProperties"),t=require("@iframe-resizer/core"),o=require("react"),i=require("warning");var c=["license","bodyBackground","bodyMargin","bodyPadding","checkOrigin","inPageLinks","offset","offsetHeight","offsetWidth","scrolling","warningTimeout","tolerance","onClosed","onReady","onMessage","onResized"];var u=["title","forwardRef"];function s(e,r){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);r&&(t=t.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),n.push.apply(n,t)}return n}function a(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?s(Object(t),!0).forEach((function(n){r(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):s(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}module.exports=function(r){var s=r.title,f=void 0===s?"iframe":s,l=r.forwardRef,d=n(r,u),g=function(e){return e.license,e.bodyBackground,e.bodyMargin,e.bodyPadding,e.checkOrigin,e.inPageLinks,e.offset,e.offsetHeight,e.offsetWidth,e.scrolling,e.warningTimeout,e.tolerance,e.onClosed,e.onReady,e.onMessage,e.onResized,n(e,c)}(d),b=o.useRef(null),m=function(){var e;return i(!b.current,"[iframeSizerReact][".concat(null==b||null===(e=b.current)||void 0===e?void 0:e.id,"] Close event ignored, to remove the iframe update your React component")),!b.current};return o.useEffect((function(){var e=b.current,r=t(a(a({},d),{},{onClose:m}))(e);return function(){return null==r?void 0:r.disconnect()}}),[]),o.useImperativeHandle(l,(function(){return{getRef:function(){return b},getElement:function(){return b.current},resize:function(){return b.current.iframeResizer.resize()},moveToAnchor:function(e){return b.current.iframeResizer.moveToAnchor(e)},sendMessage:function(e,r){b.current.iframeResizer.sendMessage(e,r)}}})),o.createElement("iframe",e({title:f},g,{ref:b}))};

package/index.esm.js

@@ -1,7 +1,7 @@
 /*!
  *  @preserve
  *  
- *  @module     iframe-resizer/react 5.0.0-beta.4 (esm) - 2024-05-10
+ *  @module     iframe-resizer/react 5.0.0 (esm) - 2024-05-19
  *
  *  @license    GPL-3.0 for non-commercial use only.
  *              For commercial use, you must purchase a license from
@@ -17,4 +17,4 @@
  */
 
 
-import e from"@babel/runtime/helpers/extends";import r from"@babel/runtime/helpers/defineProperty";import t from"@babel/runtime/helpers/objectWithoutProperties";import n from"@iframe-resizer/core";import o,{useRef as i,useEffect as c,useImperativeHandle as f}from"react";import a from"warning";var u=["license","bodyBackground","bodyMargin","bodyPadding","checkOrigin","inPageLinks","offset","offsetHeight","offsetWidth","scrolling","warningTimeout","tolerance","onClosed","onReady","onMessage","onResized"];var s=["title","forwardRef"];function l(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function d(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(n,r))}))}return e}function m(r){var l=r.title,m=void 0===l?"iframe":l,g=r.forwardRef,p=t(r,s),b=function(e){return e.license,e.bodyBackground,e.bodyMargin,e.bodyPadding,e.checkOrigin,e.inPageLinks,e.offset,e.offsetHeight,e.offsetWidth,e.scrolling,e.warningTimeout,e.tolerance,e.onClosed,e.onReady,e.onMessage,e.onResized,t(e,u)}(p),y=i(null),O=function(){var e;return a(!y.current,"[iframeSizerReact][".concat(null==y||null===(e=y.current)||void 0===e?void 0:e.id,"] Close event ignored, to remove the iframe update your React component")),!y.current};return c((function(){var e=y.current,r=n(d(d({},p),{},{onClose:O}))(e);return function(){return null==r?void 0:r.disconnect()}}),[]),f(g,(function(){return{getIframeElement:function(){return y.current},resize:function(){return y.current.iframeResizer.resize()},moveToAnchor:function(e){return y.current.iframeResizer.moveToAnchor(e)},sendMessage:function(e,r){y.current.iframeResizer.sendMessage(e,r)}}})),o.createElement("iframe",e({title:m},b,{ref:y}))}export{m as default};
+import e from"@babel/runtime/helpers/extends";import r from"@babel/runtime/helpers/defineProperty";import t from"@babel/runtime/helpers/objectWithoutProperties";import n from"@iframe-resizer/core";import o,{useRef as i,useEffect as c,useImperativeHandle as f}from"react";import u from"warning";var a=["license","bodyBackground","bodyMargin","bodyPadding","checkOrigin","inPageLinks","offset","offsetHeight","offsetWidth","scrolling","warningTimeout","tolerance","onClosed","onReady","onMessage","onResized"];var s=["title","forwardRef"];function l(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function d(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(n,r))}))}return e}function m(r){var l=r.title,m=void 0===l?"iframe":l,g=r.forwardRef,p=t(r,s),b=function(e){return e.license,e.bodyBackground,e.bodyMargin,e.bodyPadding,e.checkOrigin,e.inPageLinks,e.offset,e.offsetHeight,e.offsetWidth,e.scrolling,e.warningTimeout,e.tolerance,e.onClosed,e.onReady,e.onMessage,e.onResized,t(e,a)}(p),y=i(null),O=function(){var e;return u(!y.current,"[iframeSizerReact][".concat(null==y||null===(e=y.current)||void 0===e?void 0:e.id,"] Close event ignored, to remove the iframe update your React component")),!y.current};return c((function(){var e=y.current,r=n(d(d({},p),{},{onClose:O}))(e);return function(){return null==r?void 0:r.disconnect()}}),[]),f(g,(function(){return{getRef:function(){return y},getElement:function(){return y.current},resize:function(){return y.current.iframeResizer.resize()},moveToAnchor:function(e){return y.current.iframeResizer.moveToAnchor(e)},sendMessage:function(e,r){y.current.iframeResizer.sendMessage(e,r)}}})),o.createElement("iframe",e({title:m},b,{ref:y}))}export{m as default};

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@iframe-resizer/react",
-  "version": "5.0.0-beta.4",
+  "version": "5.0.0",
   "license": "GPL-3.0",
   "homepage": "https://iframe-resizer.com",
   "author": {
     "name": "David J. Bradshaw",
     "email": "dave@bradshaw.net"
   },
-  "description": "Keep same and cross domain iFrames sized to their content with support for window/content resizing, and multiple iFrames.",
+  "description": "Keep same and cross domain iFrames sized to their content.",
   "github": "https://github.com/davidjbradshaw/iframe-resizer",
   "repository": {
     "type": "git",
-    "url": "https://github.com/davidjbradshaw/iframe-resizer.git"
+    "url": "git+https://github.com/davidjbradshaw/iframe-resizer.git"
   },
   "funding": {
     "type": "individual",
-    "url": "https://github.com/davidjbradshaw/iframe-resizer/blob/master/FUNDING.md"
+    "url": "https://iframe-resizer.com/licenses/"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
@@ -25,7 +25,7 @@
   "module": "index.esm.js",
   "types": "iframe-resizer.react.d.ts",
   "keywords": [
-    "iFrame",
+    "iframe",
     "Resizing",
     "Resizer",
     "auto-height",
@@ -45,7 +45,7 @@
     "react"
   ],
   "dependencies": {
-    "@iframe-resizer/core": "5.0.0-beta.4",
+    "@iframe-resizer/core": "5.0.0",
     "warning": "^4.0.3"
   }
 }