🤖 Merge PR DefinitelyTyped#72395 feat(react-highcharts): add missing props & methods, resolve attw by @hkleungai

Author: hkleungai

attw.json

@@ -253,7 +253,6 @@
         "react-dynamic-number",
         "react-embed-gist",
         "react-facebook-login",
-        "react-highcharts",
         "react-highlight",
         "react-holder",
         "react-howler",

types/react-highcharts/index.d.ts

@@ -1,30 +1,44 @@
 import * as Highcharts from "highcharts";
 import * as React from "react";
 
-/**
- * Props for ReactHighcharts component.
- */
-interface ReactHighchartsProps {
+declare namespace ReactHighcharts {
     /**
-     * Highcharts configuration options.
+     * Props for ReactHighcharts component.
      */
-    config: Highcharts.Options;
-    /**
-     * @param after-render callback.
-     */
-    callback?(chart: Highcharts.ChartObject): void;
+    interface ReactHighchartsProps {
+        /**
+         * Highcharts configuration options.
+         */
+        config: Highcharts.Options;
 
-    /**
-     * Chart will not rerender if the config is referentially equal to previous and this property is true
-     */
-    isPureConfig?: boolean | undefined;
+        /**
+         * Chart will not rerender if the config is referentially equal to previous and this property is true
+         */
+        isPureConfig?: boolean | undefined;
+
+        neverReflow?: boolean | undefined;
+
+        /**
+         * after-render callback.
+         */
+        callback?: ((chart: Highcharts.ChartObject) => void) | undefined;
+
+        /**
+         * Passing properties to the wrapping DOM element
+         */
+        domProps?: Partial<React.JSX.IntrinsicElements["div"]> | undefined;
+    }
+
+    function withHighcharts(Highcharts: Highcharts.Static): typeof ReactHighcharts;
 }
 
 /**
  * React interface for highcharts.
  */
-declare class ReactHighcharts extends React.Component<ReactHighchartsProps> {
+declare class ReactHighcharts extends React.Component<ReactHighcharts.ReactHighchartsProps> {
+    static chartType: string;
     static Highcharts: Highcharts.Static;
+    static displayName: string;
 }
 
-export default ReactHighcharts;
+export = ReactHighcharts;

types/react-highcharts/react-highcharts-tests.tsx

@@ -2,16 +2,35 @@ import * as Highcharts from "highcharts";
 import * as React from "react";
 import ReactHighcharts from "react-highcharts";
 
-const config: Highcharts.Options = {};
+// @ts-ignore - `props.config` is required
+<ReactHighcharts />;
 
-function callback(chart: Highcharts.ChartObject): void {}
+// With required props
+<ReactHighcharts config={{}} />;
 
-const isPureConfig = true;
+// With optional props
+<ReactHighcharts
+    config={{}}
+    isPureConfig={true}
+    neverReflow={true}
+    callback={(chart) => {
+        // $ExpectType ChartObject
+        chart;
+    }}
+    domProps={{
+        className: "div-classname",
+    }}
+/>;
 
-export const _ = () => (
-    <>
-        <ReactHighcharts config={config} />
-        <ReactHighcharts config={config} callback={callback} />
-        <ReactHighcharts config={config} callback={callback} isPureConfig={isPureConfig} />
-    </>
-);
+// $ExpectType string
+ReactHighcharts.chartType;
+
+// $ExpectType Static
+ReactHighcharts.Highcharts;
+
+// $ExpectType string
+ReactHighcharts.displayName;
+
+// $ExpectType typeof ReactHighcharts
+const AnotherReactHighcharts = ReactHighcharts.withHighcharts(ReactHighcharts.Highcharts);
+<AnotherReactHighcharts config={{}} />;