victory-cursor-container 36.6.0 → 36.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "victory-cursor-container",
-  "version": "36.6.0",
+  "version": "36.6.1",
   "description": "Interactive Cursor Component for Victory",
   "keywords": [
     "data visualization",
@@ -22,7 +22,7 @@
   "dependencies": {
     "lodash": "^4.17.19",
     "prop-types": "^15.8.1",
-    "victory-core": "^36.6.0"
+    "victory-core": "^36.6.1"
   },
   "peerDependencies": {
     "react": ">=16.6.0"
@@ -123,6 +123,14 @@
         "pnpm-lock.yaml"
       ]
     },
+    "check": {
+      "dependencies": [
+        "types:check",
+        "jest",
+        "format",
+        "lint"
+      ]
+    },
     "types:check": {
       "command": "nps types:pkg:check",
       "files": [
@@ -175,6 +183,19 @@
         "pnpm-lock.yaml"
       ]
     },
+    "format:fix": {
+      "command": "pnpm run format || nps format:pkg:fix",
+      "files": [
+        "src/**",
+        "*.json",
+        "../../.prettierignore",
+        "../../.prettierrc.json"
+      ],
+      "output": [],
+      "packageLocks": [
+        "pnpm-lock.yaml"
+      ]
+    },
     "lint": {
       "command": "nps lint:pkg",
       "files": [
@@ -192,19 +213,6 @@
         "pnpm-lock.yaml"
       ]
     },
-    "format:fix": {
-      "command": "pnpm run format || nps format:pkg:fix",
-      "files": [
-        "src/**",
-        "*.json",
-        "../../.prettierignore",
-        "../../.prettierrc.json"
-      ],
-      "output": [],
-      "packageLocks": [
-        "pnpm-lock.yaml"
-      ]
-    },
     "lint:fix": {
       "command": "pnpm run lint || nps lint:pkg:fix",
       "files": [
@@ -251,6 +259,7 @@
     "build:dist": "wireit",
     "build:dist:dev": "wireit",
     "build:dist:min": "wireit",
+    "check": "wireit",
     "types:check": "wireit",
     "types:create": "wireit",
     "format": "wireit",

package/src/{cursor-helpers.js → cursor-helpers.tsx}

@@ -1,16 +1,17 @@
 import { Selection } from "victory-core";
 import { throttle, isFunction, mapValues } from "lodash";
+import { SVGCoordinateType } from "victory-core/src";
 
 const ON_MOUSE_MOVE_THROTTLE_MS = 16;
 
-const CursorHelpers = {
+class CursorHelpersClass {
   getDimension(props) {
     const { horizontal, cursorDimension } = props;
     if (!horizontal || !cursorDimension) {
       return cursorDimension;
     }
     return cursorDimension === "x" ? "y" : "x";
-  },
+  }
 
   withinBounds(point, bounds) {
     const { x1, x2, y1, y2 } = mapValues(bounds, Number);
@@ -21,14 +22,14 @@ const CursorHelpers = {
       y >= Math.min(y1, y2) &&
       y <= Math.max(y1, y2)
     );
-  },
+  }
 
-  onMouseMove(evt, targetProps) {
+  private handleMouseMove = (evt, targetProps) => {
     const { onCursorChange, domain } = targetProps;
     const cursorDimension = this.getDimension(targetProps);
     const parentSVG = targetProps.parentSVG || Selection.getParentSVG(evt);
     const cursorSVGPosition = Selection.getSVGEventCoordinates(evt, parentSVG);
-    let cursorValue = Selection.getDataCoordinates(
+    let cursorValue: SVGCoordinateType | null = Selection.getDataCoordinates(
       targetProps,
       targetProps.scale,
       cursorSVGPosition.x,
@@ -47,7 +48,7 @@ const CursorHelpers = {
     }
 
     if (isFunction(onCursorChange)) {
-      if (inBounds) {
+      if (cursorValue) {
         const value = cursorDimension
           ? cursorValue[cursorDimension]
           : cursorValue;
@@ -64,9 +65,16 @@ const CursorHelpers = {
         mutation: () => ({ cursorValue, parentSVG }),
       },
     ];
-  },
+  };
 
-  onTouchEnd(evt, targetProps) {
+  onMouseMove = throttle(this.handleMouseMove, ON_MOUSE_MOVE_THROTTLE_MS, {
+    leading: true,
+    trailing: false,
+  });
+
+  onMouseLeave = this.handleMouseMove;
+
+  onTouchEnd = (evt, targetProps) => {
     const { onCursorChange } = targetProps;
 
     if (isFunction(targetProps.onCursorChange)) {
@@ -80,10 +88,12 @@ const CursorHelpers = {
         mutation: () => ({ cursorValue: null }),
       },
     ];
-  },
-};
+  };
+}
 
-export default {
+export const CursorHelpers = new CursorHelpersClass();
+
+/* {
   ...CursorHelpers,
   onMouseMove: throttle(
     CursorHelpers.onMouseMove.bind(CursorHelpers),
@@ -96,3 +106,6 @@ export default {
   onMouseLeave: CursorHelpers.onMouseMove.bind(CursorHelpers),
   onTouchEnd: CursorHelpers.onTouchEnd.bind(CursorHelpers),
 };
+
+
+   */

package/src/index.tsx

@@ -0,0 +1,2 @@
+export * from "./cursor-helpers";
+export * from "./victory-cursor-container";

package/src/{victory-cursor-container.js → victory-cursor-container.tsx}

@@ -5,12 +5,38 @@ import {
   VictoryLabel,
   LineSegment,
   Helpers,
+  VictoryContainerProps,
+  CoordinatesPropType,
+  VictoryLabelProps,
+  ValueOrCallback,
 } from "victory-core";
 import { defaults, assign, isObject } from "lodash";
-import CursorHelpers from "./cursor-helpers";
+import { CursorHelpers } from "./cursor-helpers";
 
-export const cursorContainerMixin = (base) =>
-  class VictoryCursorContainer extends base {
+export type CursorCoordinatesPropType = CoordinatesPropType | number;
+
+export interface VictoryCursorContainerProps extends VictoryContainerProps {
+  cursorComponent?: React.ReactElement;
+  cursorDimension?: "x" | "y";
+  cursorLabel?: ValueOrCallback<VictoryLabelProps["text"]>;
+  cursorLabelComponent?: React.ReactElement;
+  cursorLabelOffset?: CursorCoordinatesPropType;
+  defaultCursorValue?: CursorCoordinatesPropType;
+  disable?: boolean;
+  onCursorChange?: (
+    value: CursorCoordinatesPropType,
+    props: VictoryCursorContainerProps,
+  ) => void;
+}
+
+type ComponentClass<TProps> = { new (props: TProps): React.Component<TProps> };
+
+export function cursorContainerMixin<
+  TBase extends ComponentClass<TProps>,
+  TProps extends VictoryCursorContainerProps,
+>(Base: TBase) {
+  // @ts-expect-error "TS2545: A mixin class must have a constructor with a single rest parameter of type 'any[]'."
+  return class VictoryCursorContainer extends Base {
     static displayName = "VictoryCursorContainer";
     static propTypes = {
       ...VictoryContainer.propTypes,
@@ -134,7 +160,7 @@ export const cursorContainerMixin = (base) =>
         return [];
       }
 
-      const newElements = [];
+      const newElements: React.ReactElement[] = [];
       const padding = this.getPadding(props);
       const cursorCoordinates = {
         x: horizontal ? scale.y(cursorValue.y) : scale.x(cursorValue.x),
@@ -205,5 +231,6 @@ export const cursorContainerMixin = (base) =>
       ];
     }
   };
+}
 
-export default cursorContainerMixin(VictoryContainer);
+export const VictoryCursorContainer = cursorContainerMixin(VictoryContainer);

package/src/index.d.ts

@@ -1,37 +0,0 @@
-import * as React from "react";
-import {
-  VictoryContainerProps,
-  CoordinatesPropType,
-  CallbackArgs,
-} from "victory-core";
-
-export type CursorCoordinatesPropType = CoordinatesPropType | number;
-
-export interface VictoryCursorContainerProps extends VictoryContainerProps {
-  cursorComponent?: React.ReactElement;
-  cursorDimension?: "x" | "y";
-  cursorLabel?: (point: CoordinatesPropType, args: CallbackArgs) => any | void;
-  cursorLabelComponent?: React.ReactElement;
-  cursorLabelOffset?: CursorCoordinatesPropType;
-  defaultCursorValue?: CursorCoordinatesPropType;
-  disable?: boolean;
-  onCursorChange?: (
-    value: CursorCoordinatesPropType,
-    props: VictoryCursorContainerProps,
-  ) => void;
-}
-
-export class VictoryCursorContainer extends React.Component<
-  VictoryCursorContainerProps,
-  any
-> {}
-
-export const CursorHelpers: {
-  getDimension(props): any;
-  withinBounds(point, bounds): any;
-  onMouseMove(evt, targetProps): any;
-  onMouseLeave(evt, targetProps): any;
-  onTouchEnd(evt, targetProps): any;
-};
-
-export const cursorContainerMixin: (base: Function) => Function;

package/src/index.js

@@ -1,5 +0,0 @@
-export {
-  cursorContainerMixin,
-  default as VictoryCursorContainer,
-} from "./victory-cursor-container";
-export { default as CursorHelpers } from "./cursor-helpers";