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.

3.1 KB
Raw Blame
import './Spinner.scss'

import posthog from 'posthog-js'
import { useEffect, useRef } from 'react'
import { twJoin, twMerge } from 'tailwind-merge'

import { IconPencil } from '@posthog/icons'

import { useCancelAnimationsOnUnmount } from 'lib/hooks/useCancelAnimationsOnUnmount'

function useTimingCapture(captureTime: boolean): void {
    const mountTimeRef = useRef<number>(performance.now())

    useEffect(() => {
        if (!captureTime) {
            return
        }

        const mountTime = mountTimeRef.current
        return () => {
            const visibleTimeMs = performance.now() - mountTime
            if (visibleTimeMs < 100) {
                return // Don't bother capturing really short loads
            }
            posthog.capture('spinner_unloaded', {
                visible_time_ms: visibleTimeMs,
            })
        }
    }, [captureTime])
}

export interface SpinnerProps {
    textColored?: boolean
    className?: string
    speed?: `${number}s` // Seconds
    captureTime?: boolean
    size?: 'small' | 'medium' | 'large'
    frozen?: boolean
}

/** Smoothly animated spinner for loading states. It does not indicate progress, only that something's happening. */
export function Spinner({
    textColored = false,
    className,
    speed = '1s',
    captureTime = false,
    size = 'small',
    frozen = false,
}: SpinnerProps): JSX.Element {
    useTimingCapture(captureTime)
    const ref = useCancelAnimationsOnUnmount<SVGSVGElement>()

    return (
        <svg
            ref={ref}
            // eslint-disable-next-line react/forbid-dom-props
            style={{ '--spinner-speed': speed } as React.CSSProperties}
            className={twMerge(
                'LemonIcon Spinner',
                textColored && `Spinner--textColored`,
                size && `Spinner--${size}`,
                frozen && 'Spinner--frozen',
                className
            )}
            viewBox="0 0 48 48"
            xmlns="http://www.w3.org/2000/svg"
        >
            <g className="Spinner__layer">
                <circle cx="24" cy="24" r="16" />
            </g>
            <g className="Spinner__layer">
                <circle cx="24" cy="24" r="16" />
            </g>
        </svg>
    )
}

export function SpinnerOverlay({
    sceneLevel,
    visible = true,
    className,
    mode = 'spinning',
    ...spinnerProps
}: SpinnerProps & {
    /** @default false */
    sceneLevel?: boolean
    /** @default true */
    visible?: boolean
    /** @default "spinning" */
    mode?: 'spinning' | 'editing'
}): JSX.Element {
    return (
        <div
            className={twJoin(
                'SpinnerOverlay',
                sceneLevel && 'SpinnerOverlay--scene-level',
                sceneLevel && 'h-[calc(100vh-var(--scene-layout-header-height))]'
            )}
            aria-hidden={!visible}
        >
            {mode === 'editing' ? (
                <IconPencil className="text-5xl text-accent z-10 drop-shadow-xl" />
            ) : (
                <Spinner className={twMerge('text-5xl', className)} {...spinnerProps} />
            )}
        </div>
    )
}