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.

1.0 KB
Raw Blame
import { useEffect, useRef, useState } from 'react'

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

export function useKeyHeld(key: string): boolean {
    const isHeldRef = useRef(false)
    const [keyHeld, setKeyHeld] = useState(false)

    useEffect(() => {
        isHeldRef.current = false
        setKeyHeld(false)
    }, [key])

    useEventListener('keydown', (event) => {
        if (event.key === key && !isHeldRef.current) {
            isHeldRef.current = true
            setKeyHeld(true)
        }
    })

    useEventListener('keyup', (event) => {
        if (event.key === key && isHeldRef.current) {
            isHeldRef.current = false
            setKeyHeld(false)
        }
    })

    // A key released while the window is not focused sends no keyup, for example after Alt-Tab or
    // ⌘-Tab to another app. Without this reset the key reads as held when the user comes back.
    useEventListener('blur', () => {
        isHeldRef.current = false
        setKeyHeld(false)
    })

    return keyHeld
}