feat: Implement showDatumInTooltip in TooltipOptions to allow hiding …

…certain datums in regular TooltipRenderer. (#360) * Implement showDatumInTooltip in TooltipOptions to allow hiding certain datums in regular TooltipRenderer. * Run format over code.
TanStack · Nov 2, 2023 · 582bc33 · 582bc33
1 parent e4b1c9c
commit 582bc33
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/src/components/Tooltip.tsx b/src/components/Tooltip.tsx
@@ -41,6 +41,7 @@ export function defaultTooltip<TDatum>(
     arrowPadding: options.arrowPadding ?? 7,
     // anchor: options.anchor ?? 'closest',
     render: options.render ?? TooltipRenderer,
+    showDatumInTooltip: options.showDatumInTooltip ?? (() => true),
   }
 }
 

diff --git a/src/components/TooltipRenderer.tsx b/src/components/TooltipRenderer.tsx
@@ -54,7 +54,9 @@ function TooltipRenderer<TDatum>(props: TooltipRendererProps<TDatum>) {
 
   const { tooltip, dark } = props.getOptions()
 
-  const groupDatums = props.focusedDatum?.tooltipGroup ?? []
+  const groupDatums = (props.focusedDatum?.tooltipGroup ?? []).filter(
+    datum => tooltip.showDatumInTooltip?.(datum) ?? true
+  )
 
   const resolvedShowCount = showCount % 2 === 0 ? showCount : showCount + 1
   const length = groupDatums.length

diff --git a/src/types.ts b/src/types.ts
@@ -124,7 +124,8 @@ export type TooltipOptions<TDatum> = {
   render?: (props: TooltipRendererProps<TDatum>) => React.ReactNode
   // formatSecondary?: (d: unknown) => string | number
   // formatTertiary?: (d: unknown) => string | number
-  invert?: boolean
+  invert?: boolean,
+  showDatumInTooltip?: (datum: Datum<TDatum>) => boolean
 }
 
 export type ResolvedTooltipOptions<TDatum> = TSTB.Object.Required<