feat(bump): adjust the documentation of event handlers now that we ca…

…n get either a series or a point
plouc · May 1, 2024 · 87cb9fb · 87cb9fb
1 parent 5fa2555
commit 87cb9fb
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/website/src/data/components/bump/props.ts b/website/src/data/components/bump/props.ts
@@ -375,32 +375,32 @@ const props: ChartProperty[] = [
     {
         key: 'onMouseEnter',
         group: 'Interactivity',
-        type: '(serie: BumpComputedSerie, event: MouseEvent) => void',
-        help: 'onMouseEnter handler.',
+        type: '(data: (BumpComputedSerie | BumpPoint), event: MouseEvent) => void',
+        help: 'onMouseEnter handler, for series by default, for points if `useMesh` is `true`.',
         required: false,
         flavors: ['svg'],
     },
     {
         key: 'onMouseMove',
         group: 'Interactivity',
-        type: '(serie: BumpComputedSerie, event: MouseEvent) => void',
-        help: 'onMouseMove handler.',
+        type: '(data: (BumpComputedSerie | BumpPoint), event: MouseEvent) => void',
+        help: 'onMouseMove handler, for series by default, for points if `useMesh` is `true`.',
         required: false,
         flavors: ['svg'],
     },
     {
         key: 'onMouseLeave',
         group: 'Interactivity',
-        type: '(serie: BumpComputedSerie, event: MouseEvent) => void',
-        help: 'onMouseLeave handler.',
+        type: '(data: (BumpComputedSerie | BumpPoint), event: MouseEvent) => void',
+        help: 'onMouseLeave handler, for series by default, for points if `useMesh` is `true`.',
         required: false,
         flavors: ['svg'],
     },
     {
         key: 'onClick',
         group: 'Interactivity',
         type: '(serie: BumpComputedSerie, event: MouseEvent) => void',
-        help: 'onClick handler.',
+        help: 'onClick handler, for series by default, for points if `useMesh` is `true`.',
         required: false,
         flavors: ['svg'],
     },