All files / modules/85-cv/utils HighchartCustomTooltip.tsx

0% Statements 0/20
0% Branches 0/20
0% Functions 0/4
0% Lines 0/18

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56                                                                                                               
/*
 * Copyright 2021 Harness Inc. All rights reserved.
 * Use of this source code is governed by the PolyForm Shield 1.0.0 license
 * that can be found in the licenses directory at the root of this repository, also available at
 * https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
 */
 
import type {
  Chart as HighchartsChart,
  TooltipFormatterCallbackFunction,
  TooltipFormatterContextObject
} from 'highcharts'
import { useEffect, useState, useRef } from 'react'
import ReactDOM from 'react-dom'
 
const generateTooltipId = (chartId: number): string => `highcharts-custom-tooltip-${chartId}`
 
interface Props {
  chart: HighchartsChart | null
  children(formatterContext: TooltipFormatterContextObject): JSX.Element
}
 
export const HighchartCustomTooltip: React.FC<Props> = ({ chart, children }) => {
  const isInit = useRef(false)
  const [context, setContext] = useState<TooltipFormatterContextObject | null>(null)
 
  useEffect(() => {
    if (chart?.tooltip && chart.update) {
      const formatter: TooltipFormatterCallbackFunction = function () {
        // Ensures that tooltip DOM container is rendered before React portal is created.
        if (!isInit.current) {
          isInit.current = true
 
          chart.tooltip.refresh.apply(chart.tooltip, [this.point])
          chart.tooltip.hide(0)
        }
 
        setContext(this)
 
        return `<div id="${generateTooltipId(chart.index)}"></div>`
      }
 
      chart.update({
        tooltip: {
          formatter,
          useHTML: true
        }
      })
    }
  }, [chart])
 
  const node = chart?.index && document.getElementById(generateTooltipId(chart.index))
 
  return node && context ? ReactDOM.createPortal(children(context), node) : null
}