From 7ab7f2ace5ae9254f95056071e73d18f84c53533 Mon Sep 17 00:00:00 2001 From: 4c656f6e Date: Tue, 26 Feb 2019 14:31:56 +1000 Subject: [PATCH 1/2] Update recharts/index.d.ts Update BarProps label to include LabelProps Change instances of React.ReactElement to React.ReactElement for backwards compatibility --- types/recharts/index.d.ts | 81 ++++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 40 deletions(-) diff --git a/types/recharts/index.d.ts b/types/recharts/index.d.ts index 44f97c933b..ac42b06667 100644 --- a/types/recharts/index.d.ts +++ b/types/recharts/index.d.ts @@ -13,6 +13,7 @@ // Andrew Palugniok // Robert Stigsson // Kosaku Kurino +// Leon Ng // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 @@ -171,9 +172,9 @@ export interface AreaProps extends EventAttributes, Partial; - dot?: boolean | object | React.ReactElement | ContentRenderer; - label?: boolean | object | ContentRenderer | React.ReactElement; + activeDot?: boolean | object | React.ReactElement | ContentRenderer; + dot?: boolean | object | React.ReactElement | ContentRenderer; + label?: boolean | object | ContentRenderer | React.ReactElement; hide?: boolean; layout?: LayoutType; baseLine?: number | any[]; @@ -215,11 +216,11 @@ export interface BarProps extends EventAttributes, Partial; + shape?: React.ReactElement | ContentRenderer; data?: BarData[]; - background?: boolean | React.ReactElement | ContentRenderer | object; + background?: boolean | React.ReactElement | ContentRenderer | object; // see label section at http://recharts.org/#/en-US/api/Bar - label?: boolean | Label | React.SFC | React.ReactElement | ContentRenderer; + label?: boolean | Label | LabelProps | React.SFC | React.ReactElement | ContentRenderer; } export class Bar extends React.Component { } @@ -259,7 +260,7 @@ export interface CartesianAxisProps extends EventAttributes, Partial | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; axisLine?: boolean | object; tickLine?: boolean | object; mirror?: boolean; @@ -285,8 +286,8 @@ export interface CartesianGridProps extends Partial { y?: number; width?: number; height?: number; - horizontal?: object | React.ReactElement | ContentRenderer | boolean; - vertical?: object | React.ReactElement | ContentRenderer | boolean; + horizontal?: object | React.ReactElement | ContentRenderer | boolean; + vertical?: object | React.ReactElement | ContentRenderer | boolean; horizontalPoints?: number[]; verticalPoints?: number[]; horizontalCoordinatesGenerator?: CoordinatesGenerator; @@ -376,7 +377,7 @@ export interface LegendPayload { export type BBoxUpdateCallback = (box: { width: number; height: number; }) => void; export interface LegendProps { - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; wrapperStyle?: object; chartWidth?: number; chartHeight?: number; @@ -411,15 +412,15 @@ export interface LineProps extends EventAttributes, Partial | boolean; - dot?: object | React.ReactElement | ContentRenderer | boolean; + activeDot?: object | React.ReactElement | ContentRenderer | boolean; + dot?: object | React.ReactElement | ContentRenderer | boolean; top?: number; left?: number; width?: number; height?: number; data?: object[]; dataKey: DataKey; // As the source code states, dataKey will replace valueKey in 1.1.0 and it'll be required (it's already required in current implementation). - label?: boolean | object | React.ReactElement | ContentRenderer; + label?: boolean | object | React.ReactElement | ContentRenderer; points?: Point[]; } @@ -450,11 +451,11 @@ export interface PieProps extends EventAttributes, Partial | React.ReactElement | boolean; + labelLine?: object | ContentRenderer | React.ReactElement | boolean; label?: { offsetRadius: number; - } | React.ReactElement | ContentRenderer | boolean; - activeShape?: object | ContentRenderer | React.ReactElement; + } | React.ReactElement | ContentRenderer | boolean; + activeShape?: object | ContentRenderer | React.ReactElement; activeIndex?: number | number[]; blendStroke?: boolean; } @@ -501,7 +502,7 @@ export interface PolarAngleAxisProps extends EventAttributes, Partial | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; ticks?: PolarAngleAxisTick[]; stroke?: string; orientation?: 'inner' | 'outer'; @@ -540,7 +541,7 @@ export interface PolarRadiusAxisProps extends EventAttributes, Partial; + tick?: boolean | object | React.ReactElement | ContentRenderer; stroke?: string; tickFormatter?: TickFormatterFunction; domain?: [PolarRadiusAxisDomain, PolarRadiusAxisDomain]; @@ -577,10 +578,10 @@ export interface RadarProps extends EventAttributes, Partial; - activeDot?: object | React.ReactElement | ContentRenderer | boolean; - dot?: object | React.ReactElement | ContentRenderer | boolean; - label?: object | React.ReactElement | ContentRenderer | boolean; + shape?: React.ReactElement | ContentRenderer; + activeDot?: object | React.ReactElement | ContentRenderer | boolean; + dot?: object | React.ReactElement | ContentRenderer | boolean; + label?: object | React.ReactElement | ContentRenderer | boolean; legendType?: LegendType; hide?: boolean; } @@ -612,15 +613,15 @@ export interface RadialBarProps extends EventAttributes, Partial | React.ReactElement; - activeShape?: object | ContentRenderer | React.ReactElement; + shape?: ContentRenderer | React.ReactElement; + activeShape?: object | ContentRenderer | React.ReactElement; cornerRadius?: number | string; minPointSize?: number; maxBarSize?: number; data?: RadialBarData[]; legendType?: LegendType; - label?: boolean | React.ReactElement | ContentRenderer | object; - background?: boolean | React.ReactElement | ContentRenderer | object; + label?: boolean | React.ReactElement | ContentRenderer | object; + background?: boolean | React.ReactElement | ContentRenderer | object; hide?: boolean; } @@ -662,7 +663,7 @@ export interface ReferenceAreaProps extends Partial { y2?: number | string; xAxisId?: string | number; yAxisId?: string | number; - shape?: ContentRenderer | React.ReactElement; + shape?: ContentRenderer | React.ReactElement; } export class ReferenceArea extends React.Component { } @@ -688,7 +689,7 @@ export interface ReferenceDotProps extends EventAttributes, Partial> & { cx: number; cy: number; } - > | React.ReactElement; + > | React.ReactElement; } export class ReferenceDot extends React.Component { } @@ -703,14 +704,14 @@ export interface ReferenceLineProps extends Partial | React.ReactElement; + label?: string | number | ContentRenderer | React.ReactElement; xAxisId?: string | number; yAxisId?: string | number; shape?: ContentRenderer< EventAttributes & Partial> & { x1: number; y1: number; x2: number; y2: number; } - > | React.ReactElement; + > | React.ReactElement; } export class ReferenceLine extends React.Component { } @@ -746,13 +747,13 @@ export interface ScatterProps extends EventAttributes, Partial; lineType?: 'joint' | 'fitting'; lineJointType?: LineType; legendType?: LegendType; activeIndex?: number; - activeShape?: object | RechartsFunction | React.ReactElement; - shape?: 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye' | React.ReactElement | ContentRenderer; + activeShape?: object | RechartsFunction | React.ReactElement; + shape?: 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye' | React.ReactElement | ContentRenderer; points?: ScatterPoint[]; hide?: boolean; data?: object[]; @@ -824,7 +825,7 @@ export interface TooltipPayload { } export interface TooltipProps extends Animatable { - content?: React.ReactElement | React.StatelessComponent | ContentRenderer; + content?: React.ReactElement | React.StatelessComponent | ContentRenderer; viewBox?: ViewBox; active?: boolean; separator?: string; @@ -833,7 +834,7 @@ export interface TooltipProps extends Animatable { itemStyle?: object; labelStyle?: object; wrapperStyle?: object; - cursor?: boolean | object | React.ReactElement | React.StatelessComponent; + cursor?: boolean | object | React.ReactElement | React.StatelessComponent; coordinate?: Coordinate; position?: Coordinate; label?: string | number; @@ -852,7 +853,7 @@ export interface TreemapProps extends EventAttributes, Animatable { data?: any[]; style?: object; aspectRatio?: number; - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; fill?: string; stroke?: string; className?: string; @@ -874,7 +875,7 @@ export interface LabelProps extends Partial { position?: PositionType; children?: React.ReactNode[] | React.ReactNode; className?: string; - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; } export class LabelList extends React.Component { } @@ -884,7 +885,7 @@ export interface LabelListProps { children?: React.ReactNode[] | React.ReactNode; className?: string; clockWise?: boolean; - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; data?: number; dataKey: string | number | RechartsFunction; formatter?: LabelFormatter; @@ -935,7 +936,7 @@ export interface XAxisProps extends EventAttributes { padding?: XPadding; allowDataOverflow?: boolean; scale?: ScaleType | RechartsFunction; - tick?: boolean | ContentRenderer | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; axisLine?: boolean | object; tickLine?: boolean | object; minTickGap?: number; @@ -989,7 +990,7 @@ export interface YAxisProps extends EventAttributes { padding?: YPadding; allowDataOverflow?: boolean; scale?: ScaleType | RechartsFunction; - tick?: boolean | ContentRenderer | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; axisLine?: boolean | object; tickLine?: boolean | object; minTickGap?: number; From 43e056c43e460793ba9f517696bd220b619f0f46 Mon Sep 17 00:00:00 2001 From: 4c656f6e Date: Wed, 27 Feb 2019 14:37:16 +1000 Subject: [PATCH 2/2] Update recharts/index.d.ts --- types/recharts/index.d.ts | 78 +++++++++++++++++++-------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/types/recharts/index.d.ts b/types/recharts/index.d.ts index ac42b06667..56ffd20265 100644 --- a/types/recharts/index.d.ts +++ b/types/recharts/index.d.ts @@ -172,9 +172,9 @@ export interface AreaProps extends EventAttributes, Partial | ContentRenderer; - dot?: boolean | object | React.ReactElement | ContentRenderer; - label?: boolean | object | ContentRenderer | React.ReactElement; + activeDot?: boolean | object | React.ReactElement | ContentRenderer; + dot?: boolean | object | React.ReactElement | ContentRenderer; + label?: boolean | object | ContentRenderer | React.ReactElement; hide?: boolean; layout?: LayoutType; baseLine?: number | any[]; @@ -216,9 +216,9 @@ export interface BarProps extends EventAttributes, Partial | ContentRenderer; + shape?: React.ReactElement | ContentRenderer; data?: BarData[]; - background?: boolean | React.ReactElement | ContentRenderer | object; + background?: boolean | React.ReactElement | ContentRenderer | object; // see label section at http://recharts.org/#/en-US/api/Bar label?: boolean | Label | LabelProps | React.SFC | React.ReactElement | ContentRenderer; } @@ -260,7 +260,7 @@ export interface CartesianAxisProps extends EventAttributes, Partial | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; axisLine?: boolean | object; tickLine?: boolean | object; mirror?: boolean; @@ -286,8 +286,8 @@ export interface CartesianGridProps extends Partial { y?: number; width?: number; height?: number; - horizontal?: object | React.ReactElement | ContentRenderer | boolean; - vertical?: object | React.ReactElement | ContentRenderer | boolean; + horizontal?: object | React.ReactElement | ContentRenderer | boolean; + vertical?: object | React.ReactElement | ContentRenderer | boolean; horizontalPoints?: number[]; verticalPoints?: number[]; horizontalCoordinatesGenerator?: CoordinatesGenerator; @@ -377,7 +377,7 @@ export interface LegendPayload { export type BBoxUpdateCallback = (box: { width: number; height: number; }) => void; export interface LegendProps { - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; wrapperStyle?: object; chartWidth?: number; chartHeight?: number; @@ -412,15 +412,15 @@ export interface LineProps extends EventAttributes, Partial | ContentRenderer | boolean; - dot?: object | React.ReactElement | ContentRenderer | boolean; + activeDot?: object | React.ReactElement | ContentRenderer | boolean; + dot?: object | React.ReactElement | ContentRenderer | boolean; top?: number; left?: number; width?: number; height?: number; data?: object[]; dataKey: DataKey; // As the source code states, dataKey will replace valueKey in 1.1.0 and it'll be required (it's already required in current implementation). - label?: boolean | object | React.ReactElement | ContentRenderer; + label?: boolean | object | React.ReactElement | ContentRenderer; points?: Point[]; } @@ -451,11 +451,11 @@ export interface PieProps extends EventAttributes, Partial | React.ReactElement | boolean; + labelLine?: object | ContentRenderer | React.ReactElement | boolean; label?: { offsetRadius: number; - } | React.ReactElement | ContentRenderer | boolean; - activeShape?: object | ContentRenderer | React.ReactElement; + } | React.ReactElement | ContentRenderer | boolean; + activeShape?: object | ContentRenderer | React.ReactElement; activeIndex?: number | number[]; blendStroke?: boolean; } @@ -502,7 +502,7 @@ export interface PolarAngleAxisProps extends EventAttributes, Partial | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; ticks?: PolarAngleAxisTick[]; stroke?: string; orientation?: 'inner' | 'outer'; @@ -541,7 +541,7 @@ export interface PolarRadiusAxisProps extends EventAttributes, Partial | ContentRenderer; + tick?: boolean | object | React.ReactElement | ContentRenderer; stroke?: string; tickFormatter?: TickFormatterFunction; domain?: [PolarRadiusAxisDomain, PolarRadiusAxisDomain]; @@ -578,10 +578,10 @@ export interface RadarProps extends EventAttributes, Partial | ContentRenderer; - activeDot?: object | React.ReactElement | ContentRenderer | boolean; - dot?: object | React.ReactElement | ContentRenderer | boolean; - label?: object | React.ReactElement | ContentRenderer | boolean; + shape?: React.ReactElement | ContentRenderer; + activeDot?: object | React.ReactElement | ContentRenderer | boolean; + dot?: object | React.ReactElement | ContentRenderer | boolean; + label?: object | React.ReactElement | ContentRenderer | boolean; legendType?: LegendType; hide?: boolean; } @@ -613,15 +613,15 @@ export interface RadialBarProps extends EventAttributes, Partial | React.ReactElement; - activeShape?: object | ContentRenderer | React.ReactElement; + shape?: ContentRenderer | React.ReactElement; + activeShape?: object | ContentRenderer | React.ReactElement; cornerRadius?: number | string; minPointSize?: number; maxBarSize?: number; data?: RadialBarData[]; legendType?: LegendType; - label?: boolean | React.ReactElement | ContentRenderer | object; - background?: boolean | React.ReactElement | ContentRenderer | object; + label?: boolean | React.ReactElement | ContentRenderer | object; + background?: boolean | React.ReactElement | ContentRenderer | object; hide?: boolean; } @@ -663,7 +663,7 @@ export interface ReferenceAreaProps extends Partial { y2?: number | string; xAxisId?: string | number; yAxisId?: string | number; - shape?: ContentRenderer | React.ReactElement; + shape?: ContentRenderer | React.ReactElement; } export class ReferenceArea extends React.Component { } @@ -689,7 +689,7 @@ export interface ReferenceDotProps extends EventAttributes, Partial> & { cx: number; cy: number; } - > | React.ReactElement; + > | React.ReactElement; } export class ReferenceDot extends React.Component { } @@ -704,14 +704,14 @@ export interface ReferenceLineProps extends Partial | React.ReactElement; + label?: string | number | ContentRenderer | React.ReactElement; xAxisId?: string | number; yAxisId?: string | number; shape?: ContentRenderer< EventAttributes & Partial> & { x1: number; y1: number; x2: number; y2: number; } - > | React.ReactElement; + > | React.ReactElement; } export class ReferenceLine extends React.Component { } @@ -747,13 +747,13 @@ export interface ScatterProps extends EventAttributes, Partial; + line?: boolean | object | RechartsFunction | React.ReactElement; lineType?: 'joint' | 'fitting'; lineJointType?: LineType; legendType?: LegendType; activeIndex?: number; - activeShape?: object | RechartsFunction | React.ReactElement; - shape?: 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye' | React.ReactElement | ContentRenderer; + activeShape?: object | RechartsFunction | React.ReactElement; + shape?: 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye' | React.ReactElement | ContentRenderer; points?: ScatterPoint[]; hide?: boolean; data?: object[]; @@ -825,7 +825,7 @@ export interface TooltipPayload { } export interface TooltipProps extends Animatable { - content?: React.ReactElement | React.StatelessComponent | ContentRenderer; + content?: React.ReactElement | React.StatelessComponent | ContentRenderer; viewBox?: ViewBox; active?: boolean; separator?: string; @@ -834,7 +834,7 @@ export interface TooltipProps extends Animatable { itemStyle?: object; labelStyle?: object; wrapperStyle?: object; - cursor?: boolean | object | React.ReactElement | React.StatelessComponent; + cursor?: boolean | object | React.ReactElement | React.StatelessComponent; coordinate?: Coordinate; position?: Coordinate; label?: string | number; @@ -853,7 +853,7 @@ export interface TreemapProps extends EventAttributes, Animatable { data?: any[]; style?: object; aspectRatio?: number; - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; fill?: string; stroke?: string; className?: string; @@ -875,7 +875,7 @@ export interface LabelProps extends Partial { position?: PositionType; children?: React.ReactNode[] | React.ReactNode; className?: string; - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; } export class LabelList extends React.Component { } @@ -885,7 +885,7 @@ export interface LabelListProps { children?: React.ReactNode[] | React.ReactNode; className?: string; clockWise?: boolean; - content?: React.ReactElement | ContentRenderer; + content?: React.ReactElement | ContentRenderer; data?: number; dataKey: string | number | RechartsFunction; formatter?: LabelFormatter; @@ -936,7 +936,7 @@ export interface XAxisProps extends EventAttributes { padding?: XPadding; allowDataOverflow?: boolean; scale?: ScaleType | RechartsFunction; - tick?: boolean | ContentRenderer | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; axisLine?: boolean | object; tickLine?: boolean | object; minTickGap?: number; @@ -990,7 +990,7 @@ export interface YAxisProps extends EventAttributes { padding?: YPadding; allowDataOverflow?: boolean; scale?: ScaleType | RechartsFunction; - tick?: boolean | ContentRenderer | object | React.ReactElement; + tick?: boolean | ContentRenderer | object | React.ReactElement; axisLine?: boolean | object; tickLine?: boolean | object; minTickGap?: number;