@types/react-calendar-heatmap - npm Package Compare versions

Comparing version 1.6.6 to 1.6.7

react-calendar-heatmap/index.d.ts

 import * as React from "react";
 
-export interface Props {
-    classForValue?: ((value: any) => any) | undefined;
+export type ReactCalendarHeatmapDate = string | number | Date;
+export interface ReactCalendarHeatmapValue<T extends ReactCalendarHeatmapDate> {
+    date: T;
+    [key: string]: any;
+}
+
+export interface Props<T extends ReactCalendarHeatmapDate> {
+    classForValue?: ((value: ReactCalendarHeatmapValue<T> | undefined) => string) | undefined;
     endDate?: string | number | Date | undefined;
@@ -10,5 +16,9 @@ gutterSize?: number | undefined;
     numDays?: number | undefined;
-    onClick?: ((value: any) => void) | undefined;
-    onMouseLeave?: ((e: any, value: any) => void) | undefined;
-    onMouseOver?: ((e: any, value: any) => void) | undefined;
+    onClick?: ((value: ReactCalendarHeatmapValue<T> | undefined) => void) | undefined;
+    onMouseLeave?:
+        | ((e: React.MouseEvent<SVGRectElement, MouseEvent>, value: ReactCalendarHeatmapValue<T> | undefined) => void)
+        | undefined;
+    onMouseOver?:
+        | ((e: React.MouseEvent<SVGRectElement, MouseEvent>, value: ReactCalendarHeatmapValue<T> | undefined) => void)
+        | undefined;
     showMonthLabels?: boolean | undefined;
@@ -18,9 +28,15 @@ showOutOfRangeDays?: boolean | undefined;
     startDate?: string | number | Date | undefined;
-    titleForValue?: ((value: any) => any) | undefined;
+    titleForValue?: ((value: ReactCalendarHeatmapValue<T> | undefined) => string) | undefined;
     tooltipDataAttrs?: object | undefined;
-    transformDayElement?: ((rect: any, value: any, index: number) => any) | undefined;
-    values: any[];
+    transformDayElement?:
+        | ((
+            element: React.ReactElement,
+            value: ReactCalendarHeatmapValue<T> | undefined,
+            index: number,
+        ) => React.ReactNode)
+        | undefined;
+    values: Array<ReactCalendarHeatmapValue<T>>;
     weekdayLabels?: string[] | undefined;
 }
 
-export default class ReactCalendarHeatmap extends React.Component<Props> {}
+export default class ReactCalendarHeatmap<T extends ReactCalendarHeatmapDate> extends React.Component<Props<T>> {}

react-calendar-heatmap/package.json

 {
     "name": "@types/react-calendar-heatmap",
-    "version": "1.6.6",
+    "version": "1.6.7",
     "description": "TypeScript definitions for react-calendar-heatmap",
@@ -25,4 +25,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-calendar-heatmap",
     },
-    "typesPublisherContentHash": "9ab951262e56a8e0b0e2b2b2f6a0270951c092ca7a20b19997de59dbc3ebe1e2",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "2f6f065c7cfdce02468db066caded4e5d1c062462d72c95674a0c018a3d826ce",
+    "typeScriptVersion": "4.6"
 }

react-calendar-heatmap/README.md

@@ -13,4 +13,10 @@ # Installation
 
-export interface Props {
-    classForValue?: ((value: any) => any) | undefined;
+export type ReactCalendarHeatmapDate = string | number | Date;
+export interface ReactCalendarHeatmapValue<T extends ReactCalendarHeatmapDate> {
+    date: T;
+    [key: string]: any;
+}
+
+export interface Props<T extends ReactCalendarHeatmapDate> {
+    classForValue?: ((value: ReactCalendarHeatmapValue<T> | undefined) => string) | undefined;
     endDate?: string | number | Date | undefined;
@@ -21,5 +27,9 @@ gutterSize?: number | undefined;
     numDays?: number | undefined;
-    onClick?: ((value: any) => void) | undefined;
-    onMouseLeave?: ((e: any, value: any) => void) | undefined;
-    onMouseOver?: ((e: any, value: any) => void) | undefined;
+    onClick?: ((value: ReactCalendarHeatmapValue<T> | undefined) => void) | undefined;
+    onMouseLeave?:
+        | ((e: React.MouseEvent<SVGRectElement, MouseEvent>, value: ReactCalendarHeatmapValue<T> | undefined) => void)
+        | undefined;
+    onMouseOver?:
+        | ((e: React.MouseEvent<SVGRectElement, MouseEvent>, value: ReactCalendarHeatmapValue<T> | undefined) => void)
+        | undefined;
     showMonthLabels?: boolean | undefined;
@@ -29,10 +39,16 @@ showOutOfRangeDays?: boolean | undefined;
     startDate?: string | number | Date | undefined;
-    titleForValue?: ((value: any) => any) | undefined;
+    titleForValue?: ((value: ReactCalendarHeatmapValue<T> | undefined) => string) | undefined;
     tooltipDataAttrs?: object | undefined;
-    transformDayElement?: ((rect: any, value: any, index: number) => any) | undefined;
-    values: any[];
+    transformDayElement?:
+        | ((
+            element: React.ReactElement,
+            value: ReactCalendarHeatmapValue<T> | undefined,
+            index: number,
+        ) => React.ReactNode)
+        | undefined;
+    values: Array<ReactCalendarHeatmapValue<T>>;
     weekdayLabels?: string[] | undefined;
 }
 
-export default class ReactCalendarHeatmap extends React.Component<Props> {}
+export default class ReactCalendarHeatmap<T extends ReactCalendarHeatmapDate> extends React.Component<Props<T>> {}
 
@@ -42,3 +58,3 @@ ````
 ### Additional Details
- * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
+ * Last updated: Sun, 14 Jan 2024 08:07:40 GMT
  * Dependencies: [@types/react](https://npmjs.com/package/@types/react)
@@ -45,0 +61,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6193

increased by30.85%

Lines of code

37

increased by68.18%

Number of lines in readme file

60

increased by36.36%

No dependency changes