Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

5.6 KB
Raw Blame
import clsx from 'clsx'
import { useValues } from 'kea'

import { heatmapDataLogic } from 'lib/components/heatmaps/heatmapDataLogic'
import { useMousePosition } from 'lib/components/heatmaps/useMousePosition'
import { useScrollSync } from 'lib/components/heatmaps/useScrollSync'
import { cn } from 'lib/utils/css-classes'

import { HeatmapElement } from '~/toolbar/shared/types'

export const scrollDepthColor = (count: number, maxCount: number, heatmapColorPalette: string | null): string => {
    const value = 1 - count / maxCount

    if (heatmapColorPalette === 'default') {
        const safeValue = Math.max(0, Math.min(1, value))
        const hue = Math.round(260 * safeValue)

        // Return hsl color. You can adjust saturation and lightness to your liking
        return `hsl(${hue}, 100%, 50%)`
    }

    const rgba = [0, 0, 0, count / maxCount]

    switch (heatmapColorPalette) {
        case 'red':
            rgba[0] = 255
            break
        case 'green':
            rgba[1] = 255
            break
        case 'blue':
            rgba[2] = 255
            break
        default:
            break
    }

    return `rgba(${rgba.join(', ')})`
}

export function ScrollDepthMouseCanvas({
    mouseY,
    shiftPressed,
    rawHeatmapLoading,
    heatmapElements,
    percentage,
}: {
    mouseY: number
    shiftPressed: boolean
    rawHeatmapLoading: boolean
    heatmapElements: HeatmapElement[]
    percentage: number
}): JSX.Element | null {
    return (
        <div
            className="absolute left-0 right-0 flex items-center z-10 -translate-y-1/2"
            // eslint-disable-next-line react/forbid-dom-props
            style={{
                top: mouseY,
            }}
        >
            <div className="border-b border-default w-full opacity-75" />
            <div
                className={clsx(
                    'bg-default whitespace-nowrap text-primary-inverse rounded p-2 font-semibold opacity-75 hover:opacity-100 transition-all',
                    !shiftPressed ? 'pointer-events-auto' : 'pointer-events-none'
                )}
            >
                {rawHeatmapLoading ? (
                    <>Loading...</>
                ) : heatmapElements.length ? (
                    <>{percentage.toPrecision(4)}% scrolled this far</>
                ) : (
                    <>No scroll data for the current dimension range</>
                )}
            </div>

            <div className="border-b border-default w-10 opacity-75" />
        </div>
    )
}

function ScrollDepthMouseInfo({
    context,
    exportToken,
}: {
    context: 'in-app' | 'toolbar'
    exportToken?: string
}): JSX.Element | null {
    const { heatmapElements, rawHeatmapLoading } = useValues(heatmapDataLogic({ context, exportToken }))

    const mouseY = useMousePosition()?.y

    if (mouseY === undefined) {
        return null
    }

    // Get the iframe's offset from the top of the viewport
    const iframe = document.getElementById('heatmap-iframe') || document.getElementById('heatmap-screenshot')
    if (!iframe) {
        return null
    }
    const iframeTop = iframe.getBoundingClientRect().top
    const relativeMouseY = mouseY - iframeTop
    const adjustedMouseY = relativeMouseY < 0 ? 0 : relativeMouseY

    const elementInMouseY = heatmapElements.find((x, i) => {
        const lastY = heatmapElements[i - 1]?.y ?? 0
        return adjustedMouseY >= lastY && adjustedMouseY < x.y
    })

    const maxCount = heatmapElements[0]?.count ?? 0
    const percentage = ((elementInMouseY?.count ?? 0) / maxCount) * 100

    return (
        <ScrollDepthMouseCanvas
            mouseY={adjustedMouseY}
            shiftPressed={false}
            rawHeatmapLoading={rawHeatmapLoading}
            heatmapElements={heatmapElements}
            percentage={percentage}
        />
    )
}

export function ScrollDepthCanvas({
    positioning = 'fixed',
    context = 'in-app',
    exportToken,
}: {
    positioning?: 'absolute' | 'fixed'
    context?: 'in-app' | 'toolbar'
    exportToken?: string
}): JSX.Element | null {
    const { heatmapElements, heatmapColorPalette, isReady } = useValues(heatmapDataLogic({ context, exportToken }))
    const { innerRef } = useScrollSync(context === 'toolbar')
    const maxCount = heatmapElements[0]?.count ?? 0

    if (!heatmapElements.length) {
        return null
    }

    return (
        <div className={cn('inset-0 overflow-hidden w-full h-full', positioning)} data-attr="scroll-depth-canvas">
            <div
                ref={innerRef}
                className={cn(
                    'absolute top-0 left-0 right-0 transition-opacity duration-150',
                    isReady ? 'heatmaps-ready opacity-100' : 'heatmaps-loading opacity-40 pointer-events-none'
                )}
                // eslint-disable-next-line react/forbid-dom-props
                style={{
                    willChange: context === 'toolbar' ? 'transform' : undefined,
                }}
            >
                {heatmapElements.map(({ y, count }, i) => (
                    <div
                        key={y}
                        className="absolute left-0 w-full opacity-50"
                        // eslint-disable-next-line react/forbid-dom-props
                        style={{
                            top: heatmapElements[i - 1]?.y ?? 0,
                            height: y - (heatmapElements[i - 1]?.y ?? 0),
                            backgroundColor: scrollDepthColor(count, maxCount, heatmapColorPalette),
                        }}
                    />
                ))}
            </div>
            <ScrollDepthMouseInfo context={context} exportToken={exportToken} />
        </div>
    )
}