Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(types): improve typings for onMouseLeave/Enter in Bar/Pie #939

Merged
merged 2 commits into from
May 16, 2020
Merged

fix(types): improve typings for onMouseLeave/Enter in Bar/Pie #939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4fb50b
fix(bar): improved mouse enter/leave types
mathieumg Apr 30, 2020
23846d4
fix(pie): improved mouse enter/leave types
mathieumg Apr 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions packages/bar/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@ declare module '@nivo/bar' {

export type ValueFormatter = (value: number) => string | number

export type BarClickHandler = (

export type BarMouseEventHandler<T = HTMLCanvasElement> = (
datum: BarExtendedDatum,
event: React.MouseEvent<HTMLCanvasElement>
event: React.MouseEvent<T>
) => void

export type TooltipProp = React.StatelessComponent<BarExtendedDatum>
Expand All @@ -72,7 +73,9 @@ declare module '@nivo/bar' {
label: string
shouldRenderLabel: boolean
labelColor: string
onClick: BarClickHandler
onClick: BarMouseEventHandler
onMouseEnter: BarMouseEventHandler
onMouseLeave: BarMouseEventHandler
tooltipFormat: string | ValueFormatter
tooltip: TooltipProp
showTooltip: (tooltip: React.ReactNode, event: React.MouseEvent<HTMLCanvasElement>) => void
Expand Down Expand Up @@ -156,7 +159,9 @@ declare module '@nivo/bar' {
SvgDefsAndFill<BarDatum> &
Partial<{
layers: Layer[]
onClick: (datum: BarExtendedDatum, event: React.MouseEvent<SVGRectElement>) => void
onClick: BarMouseEventHandler<SVGRectElement>
onMouseEnter: BarMouseEventHandler<SVGRectElement>
onMouseLeave: BarMouseEventHandler<SVGRectElement>
}>

export class Bar extends React.Component<BarSvgProps & Dimensions> {}
Expand All @@ -165,7 +170,9 @@ declare module '@nivo/bar' {
export type BarCanvasProps = Data &
BarProps &
Partial<{
onClick: BarClickHandler
onClick: BarMouseEventHandler
onMouseEnter: BarMouseEventHandler
onMouseLeave: BarMouseEventHandler
pixelRatio: number
}>

Expand Down
18 changes: 16 additions & 2 deletions packages/pie/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ declare module '@nivo/pie' {

export type ValueFormatter = (value: number) => string | number

export type PieMouseEventHandler<T = HTMLCanvasElement> = (
datum: PieDatum,
event: React.MouseEvent<T>
) => void

export interface Data {
data: PieDatum[]
}
Expand Down Expand Up @@ -60,14 +65,20 @@ declare module '@nivo/pie' {

// interactivity
isInteractive: boolean
onClick: (datum: PieDatum, event: React.MouseEvent<SVGPathElement>) => void
tooltipFormat: string | ValueFormatter
tooltip: React.StatelessComponent<PieDatumWithColor>

legends: LegendProps[]
}>

export type PieSvgProps = Data & CommonPieProps & SvgDefsAndFill<PieDatum>
export type PieSvgProps = Data &
CommonPieProps &
SvgDefsAndFill<PieDatum> &
Partial<{
onClick: PieMouseEventHandler<SVGPathElement>
onMouseEnter: PieMouseEventHandler<SVGPathElement>
onMouseLeave: PieMouseEventHandler<SVGPathElement>
}>

export class Pie extends React.Component<PieSvgProps & Dimensions> {}
export class ResponsivePie extends React.Component<PieSvgProps> {}
Expand All @@ -76,6 +87,9 @@ declare module '@nivo/pie' {
CommonPieProps &
Partial<{
pixelRatio: number
onClick: PieMouseEventHandler
onMouseEnter: PieMouseEventHandler
onMouseLeave: PieMouseEventHandler
}>

export class PieCanvas extends React.Component<PieCanvasProps & Dimensions> {}
Expand Down