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.5 KB
Raw Blame
// The app-facing entry point for the PostHog logo. Always import from `lib/brand` — never
// `@posthog/brand/logo` directly. The raw package is presentation-only (its gradient wordmark
// is hard-coded `#111`, so it isn't theme-aware); this module is the single choke point that
// adapts it to dark mode, so that behavior can't drift per-consumer.
import { Logo as BrandLogo } from '@posthog/brand/logo'
import type { LogoProps, LogomarkProps } from '@posthog/brand/logo'

import { cn } from 'lib/utils/css-classes'

/**
 * Named logo sizes. Callers pick one of these instead of hand-tuning pixel dimensions per surface —
 * `md` is the standard logo (the landscape mark renders at the ubiquitous 160px width). A token sets
 * the rendered **height**; width always follows from the mark's aspect ratio, so call sites never
 * set width and height themselves. Omit `size` to fill the container (`width: 100%`, e.g. the toolbar).
 */
export type LogoSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl'

const LOGO_SIZE_HEIGHTS: Record<LogoSize, number> = {
    xs: 20, // minimal: exporter chrome, where the logo is a byline rather than a header
    sm: 24, // compact: watermarks, inline marks
    md: 28, // default: the standard logo — landscape renders at 160px wide (player, most surfaces)
    lg: 32, // prominent: page headers users linger on (login, onboarding)
    xl: 48, // hero: emphasis surfaces (coupon campaigns, splash screens)
}

// Package props are width-driven (`size`/`width` set width, height follows). We drive by height
// instead, so one token scales any layout consistently — hide the raw dimension props from callers.
type WithLogoSize<P> = Omit<P, 'size' | 'width' | 'height'> & { size?: LogoSize }
export type AppLogoProps = WithLogoSize<LogoProps>
export type AppLogomarkProps = WithLogoSize<LogomarkProps>

/**
 * The PostHog logo, adapted to the app's theme. With no explicit `variant` it renders the
 * gradient mark in light mode and a white mono mark in dark mode (the package gradient wordmark
 * is hard-coded dark, so it can't invert on its own). Pin a `variant` for always-light surfaces.
 */
export function Logo({ variant, className, size, ...props }: AppLogoProps): JSX.Element {
    const height = size ? LOGO_SIZE_HEIGHTS[size] : undefined
    if (variant) {
        return <BrandLogo variant={variant} height={height} className={className} {...props} />
    }
    return (
        <>
            <BrandLogo height={height} className={cn('dark:hidden', className)} {...props} />
            <BrandLogo
                variant="mono"
                color="white"
                height={height}
                className={cn('hidden dark:block', className)}
                {...props}
            />
        </>
    )
}

/**
 * The hedgehog logomark, theme-aware like {@link Logo}. `size` sets the height (see {@link LogoSize});
 * `jumpOnClick` and other package props pass through.
 */
export function Logomark({ variant, className, size, ...props }: AppLogomarkProps): JSX.Element {
    const height = size ? LOGO_SIZE_HEIGHTS[size] : undefined
    if (variant) {
        return <BrandLogo.Logomark variant={variant} height={height} className={className} {...props} />
    }

    return (
        <>
            <BrandLogo.Logomark height={height} className={cn('dark:hidden', className)} {...props} />
            <BrandLogo.Logomark
                variant="mono"
                color="white"
                height={height}
                className={cn('hidden dark:block', className)}
                {...props}
            />
        </>
    )
}