Merge pull request #65 from JakeGinnivan/typescript

marchaos · web-flow · commit f2f457a914f6 · 2024-12-31T10:58:32.000Z
Add support for React 19 + convert to typescript
diff --git a/_webpack.dist.config.js b/_webpack.dist.config.js
diff --git a/demo/demo.jsx b/demo/demo.jsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import Popout from '../lib/react-popout.jsx';
+import Popout from '../lib/react-popout';
 
 export default class Example extends React.Component {
   constructor(props) {
diff --git a/demo/demo2.jsx b/demo/demo2.jsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import Popout from '../lib/react-popout.jsx';
+import Popout from '../lib/react-popout';
 
 export default class Example2 extends React.Component {
   constructor(props) {
diff --git a/demo/demo3.jsx b/demo/demo3.jsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import Popout from '../lib/react-popout.jsx';
+import Popout from '../lib/react-popout';
 
 export default class Example3 extends React.Component {
   constructor(props) {
diff --git a/jsconfig.json b/jsconfig.json
diff --git a/lib/react-popout.tsx b/lib/react-popout.tsx
@@ -1,6 +1,5 @@
-import React from 'react';
-import { createRoot } from 'react-dom/client';
-import PropTypes from 'prop-types';
+import React, { PropsWithChildren } from 'react';
+import { createRoot, Root } from 'react-dom/client';
 
 const DEFAULT_OPTIONS = {
     toolbar: 'no',
@@ -12,44 +11,47 @@ const DEFAULT_OPTIONS = {
     resizable: 'yes',
     width: 500,
     height: 400,
-    top: (o, w) => (w.innerHeight - o.height) / 2 + w.screenY,
-    left: (o, w) => (w.innerWidth - o.width) / 2 + w.screenX
+    top: (o: any, w: any) => (w.innerHeight - o.height) / 2 + w.screenY,
+    left: (o: any, w: any) => (w.innerWidth - o.width) / 2 + w.screenX,
 };
 
 const ABOUT_BLANK = 'about:blank';
 
+interface PopoutWindowProps extends PropsWithChildren<any> {
+    options: object;
+    url: string;
+    containerId: string;
+    containerClassName?: string;
+    onError: () => void;
+    window?: Window;
+    title?: string;
+}
+
+interface PopoutWindowState {
+    popoutWindow: Window | null;
+    container: HTMLDivElement | null;
+    openedWindowComponent: React.Component | null;
+}
+
 /**
  * @class PopoutWindow
  */
-export default class PopoutWindow extends React.Component {
+export default class PopoutWindow extends React.Component<PopoutWindowProps, PopoutWindowState> {
+    private interval!: number;
+    private root!: Root;
+
     static defaultProps = {
         url: ABOUT_BLANK,
         containerId: 'popout-content-container',
         containerClassName: '',
-        onError: () => {}
-    };
-
-    /**
-     *
-     * @type {{title: *, url: *, onClosing: *, options: *, window: *, containerId: *}}
-     */
-    static propTypes = {
-        title: PropTypes.string.isRequired,
-        url: PropTypes.string,
-        onClosing: PropTypes.func,
-        options: PropTypes.object,
-        window: PropTypes.object,
-        containerId: PropTypes.string,
-        containerClassName: PropTypes.string,
-        children: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
-        onError: PropTypes.func
+        onError: () => {},
     };
 
     /**
      * @constructs PopoutWindow
      * @param props
      */
-    constructor(props) {
+    constructor(props: PopoutWindowProps) {
         super(props);
 
         this.mainWindowClosed = this.mainWindowClosed.bind(this);
@@ -59,21 +61,24 @@ export default class PopoutWindow extends React.Component {
         this.state = {
             openedWindowComponent: null,
             popoutWindow: null,
-            container: null
+            container: null,
         };
     }
 
-    createOptions(ownerWindow) {
+    createOptions(ownerWindow: Window) {
         const mergedOptions = Object.assign({}, DEFAULT_OPTIONS, this.props.options);
 
         return Object.keys(mergedOptions)
             .map(
-                key =>
+                (key) =>
                     key +
                     '=' +
+                    // @ts-ignore
                     (typeof mergedOptions[key] === 'function'
-                        ? mergedOptions[key].call(this, mergedOptions, ownerWindow)
-                        : mergedOptions[key])
+                        ? // @ts-ignore
+                          mergedOptions[key].call(this, mergedOptions, ownerWindow)
+                        : // @ts-ignore
+                          mergedOptions[key]),
             )
             .join(',');
     }
@@ -90,44 +95,45 @@ export default class PopoutWindow extends React.Component {
         }
     }
 
-    componentWillReceiveProps(newProps) {
+    componentWillReceiveProps(newProps: PopoutWindowProps) {
         if (newProps.title !== this.props.title && this.state.popoutWindow) {
-            this.state.popoutWindow.document.title = newProps.title;
+            this.state.popoutWindow.document.title = newProps.title!;
         }
     }
 
     componentDidUpdate() {
-        this.renderToContainer(this.state.container, this.state.popoutWindow, this.props.children);
+        this.renderToContainer(this.state.container!, this.state.popoutWindow!, this.props.children);
     }
 
     componentWillUnmount() {
         this.mainWindowClosed();
     }
 
-    popoutWindowLoaded(popoutWindow) {
+    popoutWindowLoaded(popoutWindow: Window) {
         if (!this.state.container) {
             // Popout window is passed from openPopoutWindow if no url is specified.
             // In this case this.state.popoutWindow will not yet be set, so use the argument.
             popoutWindow = this.state.popoutWindow || popoutWindow;
-            popoutWindow.document.title = this.props.title;
+            popoutWindow.document.title = this.props.title!;
             let container = popoutWindow.document.createElement('div');
             container.id = this.props.containerId;
-            container.className = this.props.containerClassName;
+            container.className = this.props.containerClassName!;
             popoutWindow.document.body.appendChild(container);
 
             this.setState({ container });
             this.renderToContainer(container, popoutWindow, this.props.children);
         }
     }
 
-    openPopoutWindow(ownerWindow) {
+    openPopoutWindow(ownerWindow: Window) {
         const popoutWindow = ownerWindow.open(this.props.url, this.props.name || this.props.title, this.createOptions(ownerWindow));
         if (!popoutWindow) {
             this.props.onError();
             return;
         }
         this.setState({ popoutWindow });
 
+        // @ts-ignore
         popoutWindow.addEventListener('load', this.popoutWindowLoaded);
         popoutWindow.addEventListener('unload', this.popoutWindowUnloading);
 
@@ -153,8 +159,8 @@ export default class PopoutWindow extends React.Component {
      *
      * @param popoutWindow
      */
-    checkForPopoutWindowClosure(popoutWindow) {
-        this.interval = setInterval(() => {
+    checkForPopoutWindowClosure(popoutWindow: Window) {
+        this.interval = window.setInterval(() => {
             if (popoutWindow.closed) {
                 clearInterval(this.interval);
                 this.props.onClosing && this.props.onClosing(popoutWindow);
@@ -170,18 +176,15 @@ export default class PopoutWindow extends React.Component {
     popoutWindowUnloading() {
         if (this.state.container) {
             clearInterval(this.interval);
-            this.root.unmount(this.state.container);
+            this.root.unmount();
             this.props.onClosing && this.props.onClosing(this.state.popoutWindow);
         }
     }
 
-    renderToContainer(container, popoutWindow, children) {
+    renderToContainer(container: HTMLDivElement, popoutWindow: Window, children: React.ReactNode | ((window: Window) => React.ReactNode)) {
         // For SSR we might get updated but there will be no container.
         if (container) {
-            let renderedComponent = children;
-            if (typeof children === 'function') {
-                renderedComponent = children(popoutWindow);
-            }
+            const renderedComponent = typeof children === 'function' ? children(popoutWindow) : children;
 
             if (!this.root) {
                 this.root = createRoot(container);
diff --git a/package.json b/package.json
@@ -1,8 +1,9 @@
 {
     "name": "react-popout",
-    "version": "3.0.4",
+    "version": "4.0.0",
     "description": "Wraps window.open in a react component, allowing the contents to be part of your react render tree",
     "main": "dist/react-popout.min.js",
+    "types": "dist/react-popout.d.ts",
     "repository": {
         "type": "git",
         "url": "https://github.com/JakeGinnivan/react-popout"
@@ -19,7 +20,9 @@
     "scripts": {
         "prebuild:demo": "npm run build:dist",
         "demo": "webpack-dev-server --progress --colors --hot -d --port 8880 --config _webpack.demo.config.js",
-        "build:dist": "webpack --config _webpack.dist.config.js --optimize-minimize",
+        "build:dist": "npm run build:compile && npm run build:minify",
+        "build:compile": "tsc",
+        "build:minify": "esbuild dist/react-popout.js --minify --outfile=dist/react-popout.min.js",
         "build:demo": "webpack --config _webpack.demo.config.js --optimize-minimize",
         "test": "mocha \"test/**/*spec.js*\" --compilers js:babel-register --reporter dot",
         "prepublish": "npm run build:dist"
@@ -33,7 +36,10 @@
         "babel-loader": "^7.1.2",
         "babel-preset-es2015": "^6.6.0",
         "babel-preset-react": "^6.5.0",
+        "esbuild": "^0.24.2",
         "babel-preset-stage-0": "^6.5.0",
+        "@types/react": "^19.0.2",
+        "@types/react-dom": "^19.0.2",
         "babel-runtime": "^6.26.0",
         "eslint-config-airbnb": "latest",
         "eslint-config-prettier": "latest",
@@ -43,14 +49,14 @@
         "eslint-plugin-react": "latest",
         "mocha": "^3.5.3",
         "node-libs-browser": "^2.0.0",
-        "prettier": "latest",
+        "prettier": "^3.4.2",
         "webpack": "^3.6.0",
-        "webpack-dev-server": "^2.8.2"
+        "webpack-dev-server": "^2.8.2",
+        "typescript": "^5.7.2"
     },
     "dependencies": {
-        "prop-types": "^15.8.1",
-        "react": "^18.2.0",
-        "react-dom": "^18.2.0"
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0"
     },
     "peerDependencies": {
         "react": "^18.2.0",
diff --git a/tests.webpack.js b/tests.webpack.js
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "dist/",
+    "lib": [
+      "es2020", "dom"
+    ],
+    "jsx": "react",
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "alwaysStrict": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true
+  },
+  "include": ["lib"],
+  "exclude": [
+    "node_modules"
+  ]
+}
