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.

9.1 KB
Raw Blame
import './CardMeta.scss'

import clsx from 'clsx'
import React, { useEffect, useState } from 'react'

import { IconPieChart } from '@posthog/icons'

import { useResizeObserver } from 'lib/hooks/useResizeObserver'
import { IconSubtitles, IconSubtitlesOff } from 'lib/lemon-ui/icons'
import { LemonButton } from 'lib/lemon-ui/LemonButton'
import { More } from 'lib/lemon-ui/LemonButton/More'
import { Tooltip } from 'lib/lemon-ui/Tooltip'
import { inStorybook, inStorybookTestRunner } from 'lib/utils/dom'

import { InsightColor } from '~/types'

export interface Resizeable {
    showResizeHandles?: boolean
}

export interface CardMetaProps extends Pick<React.HTMLAttributes<HTMLDivElement>, 'className' | 'onMouseDown'> {
    compact?: boolean
    areDetailsShown?: boolean
    setAreDetailsShown?: React.Dispatch<React.SetStateAction<boolean>>
    ribbonColor?: InsightColor | null
    /** Whether the editing controls should be enabled or not. */
    showEditingControls?: boolean
    /** Whether the  controls for showing details should be enabled or not. */
    showDetailsControls?: boolean
    content?: JSX.Element | null
    metaDetails?: JSX.Element | null
    /** Buttons to show in the editing controls dropdown. */
    moreButtons?: JSX.Element
    /** Tooltip for the editing controls dropdown. */
    moreTooltip?: string
    /** Tooltip for the details button. */
    detailsTooltip?: string
    topHeading?: JSX.Element | null
    samplingFactor?: number | null
    /** Additional controls to show in the top controls area */
    extraControls?: JSX.Element | null
    /** Refresh control revealed on card hover, shown in the top controls area. */
    refreshControl?: JSX.Element | null
    headerStatus?: JSX.Element | null
    /** Description shown in the compact popover. */
    metaDescription?: JSX.Element | null
    /** Heading always shown in the popover (e.g. insight type + date range). Falls back to topHeading. */
    popoverTopHeading?: JSX.Element | null
    /** Insight title shown in the compact popover. */
    metaTitle?: string
    /** Raw description text for editing. */
    metaDescriptionText?: string
    /** When provided, makes title/description editable in the compact popover. */
    onMetaSave?: (updates: { name?: string; description?: string }) => void
}

export function CardMeta({
    compact,
    ribbonColor,
    showEditingControls,
    showDetailsControls,
    content: meta,
    metaDetails,
    moreButtons,
    moreTooltip,
    topHeading,
    areDetailsShown,
    setAreDetailsShown,
    detailsTooltip,
    className,
    onMouseDown,
    samplingFactor,
    extraControls,
    refreshControl,
    headerStatus,
}: CardMetaProps): JSX.Element {
    const { ref: primaryRef, width: primaryWidth } = useResizeObserver()
    const { ref: detailsRef, height: detailsHeight } = useResizeObserver()
    const { ref: topRef, width: topWidth } = useResizeObserver()
    const { ref: headingRef, width: headingWidth } = useResizeObserver()

    // Keep the details content mounted during the 200 ms collapse animation
    // so the outer `.CardMeta__details` height transition plays over real
    // content rather than an empty container.
    const [shouldRenderDetails, setShouldRenderDetails] = useState(areDetailsShown)
    useEffect(() => {
        if (areDetailsShown) {
            setShouldRenderDetails(true)
            return
        }
        const t = window.setTimeout(() => setShouldRenderDetails(false), 200)
        return () => clearTimeout(t)
    }, [areDetailsShown])

    // Calculate available space for controls (doesn't depend on label state, so no cyclic dependency)
    const controlsAvailableSpace = (topWidth ?? 0) - (headingWidth ?? 0)

    // Estimate space needed for controls with labels
    // These are approximate widths based on current button styles
    const buttonsWithLabels = (!compact && showDetailsControls ? 1 : 0) + (extraControls ? 1 : 0)
    const neededWidth = buttonsWithLabels * 140 // 140px per button

    // Show labels if card is wide enough AND there's room for labeled buttons
    // But also when in storybook to make it neater
    const showControlsLabels =
        inStorybook() ||
        inStorybookTestRunner() ||
        (!!primaryWidth && primaryWidth > 480 && controlsAvailableSpace >= neededWidth)
    const extraControlsWithLabel = extraControls
        ? React.cloneElement(extraControls, {
              ...extraControls.props,
              showLabel: showControlsLabels,
          })
        : null

    const editingControl = showEditingControls ? (
        moreTooltip ? (
            <Tooltip title={moreTooltip}>
                <More overlay={moreButtons} />
            </Tooltip>
        ) : (
            <More overlay={moreButtons} />
        )
    ) : null
    const compactControls = (
        <div className="CardMeta__controls">
            {refreshControl}
            {headerStatus}
            {editingControl}
        </div>
    )

    return (
        <div
            className={clsx(
                'CardMeta',
                className,
                compact && 'CardMeta--compact',
                compact && headerStatus && 'CardMeta--header-status',
                areDetailsShown && 'CardMeta--details-shown',
                onMouseDown && 'cursor-grab'
            )}
            onMouseDown={onMouseDown}
        >
            <div className="CardMeta__primary" ref={compact ? undefined : primaryRef}>
                {ribbonColor &&
                    ribbonColor !==
                        InsightColor.White /* White has historically meant no color synonymously to null */ && (
                        <div className={clsx('CardMeta__ribbon', ribbonColor)} />
                    )}
                <div className="CardMeta__main">
                    {compact ? (
                        <>
                            <div className="CardMeta__top">
                                <div className="CardMeta__heading">{topHeading}</div>
                                {!headerStatus && compactControls}
                            </div>
                            {meta}
                        </>
                    ) : (
                        <>
                            <div className="CardMeta__top" ref={topRef}>
                                <h5 ref={headingRef}>
                                    {topHeading}
                                    {samplingFactor && samplingFactor < 1 && (
                                        <Tooltip
                                            title={`Results calculated from ${100 * samplingFactor}% of users`}
                                            placement="right"
                                        >
                                            <IconPieChart
                                                className="ml-1.5 text-base align-[-0.25em]"
                                                style={{ color: 'var(--primary-3000-hover)' }}
                                            />
                                        </Tooltip>
                                    )}
                                </h5>
                                <div className="CardMeta__controls">
                                    {refreshControl}
                                    {extraControlsWithLabel}
                                    {showDetailsControls && setAreDetailsShown && (
                                        <Tooltip title={detailsTooltip}>
                                            <LemonButton
                                                icon={!areDetailsShown ? <IconSubtitles /> : <IconSubtitlesOff />}
                                                onClick={() => setAreDetailsShown((state) => !state)}
                                                size="small"
                                                active={areDetailsShown}
                                            >
                                                {showControlsLabels && `${!areDetailsShown ? 'Show' : 'Hide'} details`}
                                            </LemonButton>
                                        </Tooltip>
                                    )}
                                    {headerStatus}
                                    {editingControl}
                                </div>
                            </div>
                            {meta}
                        </>
                    )}
                </div>
                {compact && headerStatus && compactControls}
            </div>

            <div className="CardMeta__divider" />
            {!compact && (
                <div
                    className="CardMeta__details"
                    // eslint-disable-next-line react/forbid-dom-props
                    style={{
                        height: areDetailsShown && detailsHeight ? detailsHeight + 1 : 0,
                    }}
                >
                    {shouldRenderDetails && (
                        <div className="CardMeta__details__content" ref={detailsRef}>
                            {/* Stops the padding getting in the height calc  */}
                            <div className="p-4">{metaDetails}</div>
                        </div>
                    )}
                </div>
            )}
        </div>
    )
}