react-chartjs-2 - npm Package Compare versions

Comparing version 2.5.6 to 2.5.7

index.d.ts

@@ -0,22 +1,54 @@
+// Type definitions for react-chartjs-2 2.0
+// Project: https://github.com/jerairrest/react-chartjs-2
+// Definitions by: Alexandre Paré <https://github.com/apare>
+//                 Fabien Lavocat <https://github.com/FabienLavocat>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.3
 
-import * as React from 'react';
+import * as React from "react";
+import * as chartjs from "chart.js";
 
-interface ChartComponentProps {
-	data :Object;
-	height? :number;
-	legend? :Object;
-	onElementsClick? :Function;
-	options? :Object;
-	redraw? :boolean;
-	type? :String;
-	width? :number;
+export type ChartDataFunction<T extends chartjs.ChartData> = (
+  element: HTMLElement
+) => T;
+export type ChartData<T extends chartjs.ChartData> = ChartDataFunction<T> | T;
+
+export interface ChartComponentProps {
+  data: ChartData<chartjs.ChartData>;
+  type?: chartjs.ChartType;
+  getDatasetAtEvent?(e: any): void;
+  getElementAtEvent?(e: any): void;
+  getElementsAtEvent?(e: any): void;
+  height?: number;
+  legend?: chartjs.ChartLegendOptions;
+  onElementsClick?(e: any): void; // alias for getElementsAtEvent (backward compatibility)
+  options?: chartjs.ChartOptions;
+  redraw?: boolean;
+  width?: number;
 }
 
-export class Doughnut extends React.Component<ChartComponentProps, any>{}
-export class Pie extends React.Component<ChartComponentProps, any>{}
-export class Line extends React.Component<ChartComponentProps, any>{}
-export class Bar extends React.Component<ChartComponentProps, any>{}
-export class HorizontalBar extends React.Component<ChartComponentProps, any>{}
-export class Radar extends React.Component<ChartComponentProps, any>{}
-export class Polar extends React.Component<ChartComponentProps, any>{}
-export class Scatter extends React.Component<ChartComponentProps, any>{}
+export interface LinearComponentProps extends ChartComponentProps {
+  data: ChartData<chartjs.ChartData>;
+}
+
+export default class ChartComponent<
+  P extends ChartComponentProps
+> extends React.Component<P> {
+  chart_instance: chartjs;
+}
+
+export class Doughnut extends ChartComponent<ChartComponentProps> {}
+
+export class Pie extends ChartComponent<ChartComponentProps> {}
+
+export class Line extends ChartComponent<LinearComponentProps> {}
+
+export class Bar extends ChartComponent<LinearComponentProps> {}
+
+export class HorizontalBar extends ChartComponent<ChartComponentProps> {}
+
+export class Radar extends ChartComponent<ChartComponentProps> {}
+
+export class Polar extends ChartComponent<ChartComponentProps> {}
+
+export class Bubble extends ChartComponent<ChartComponentProps> {}

package.json

 {
   "name": "react-chartjs-2",
-  "version": "2.5.6",
+  "version": "2.5.7",
   "description": "react-chartjs-2",
   "main": "lib/index.js",
-  "author": "Goran Udosic",
+  "author": "Jeremy Ayerst",
   "homepage": "https://github.com/jerairrest/react-chartjs-2",
@@ -77,3 +77,4 @@ "repository": {
     "react chart.js"
-  ]
+  ],
+  "types": "./index.d.ts"
 }

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

3385557

increased by0.04%

Lines of code

83232

increased by0.03%

No dependency changes