πŸ“„ File detail

ink/terminal-focus-state.ts

🧩 .tsπŸ“ 48 linesπŸ’Ύ 1,305 bytesπŸ“ text
← Back to All Files

🎯 Use case

This file lives under β€œink/”, which covers Ink terminal UI (layouts, TTY IO, keyboard, renderer components). On the API surface it exposes TerminalFocusState, setTerminalFocused, getTerminalFocused, getTerminalFocusState, and subscribeTerminalFocus (and more) β€” mainly functions, hooks, or classes. What the file header says: Terminal focus state signal β€” non-React access to DECSET 1004 focus events. 'unknown' is the default for terminals that don't support focus reporting; consumers treat 'unknown' identically to 'focused' (no throttling). Subscribers are notified synchronously when focus changes, us.

Generated from folder role, exports, dependency roots, and inline comments β€” not hand-reviewed for every path.

🧠 Inline summary

Terminal focus state signal β€” non-React access to DECSET 1004 focus events. 'unknown' is the default for terminals that don't support focus reporting; consumers treat 'unknown' identically to 'focused' (no throttling). Subscribers are notified synchronously when focus changes, used by TerminalFocusProvider to avoid polling.

πŸ“€ Exports (heuristic)

  • TerminalFocusState
  • setTerminalFocused
  • getTerminalFocused
  • getTerminalFocusState
  • subscribeTerminalFocus
  • resetTerminalFocusState

πŸ–₯️ Source preview

// Terminal focus state signal β€” non-React access to DECSET 1004 focus events.
// 'unknown' is the default for terminals that don't support focus reporting;
// consumers treat 'unknown' identically to 'focused' (no throttling).
// Subscribers are notified synchronously when focus changes, used by
// TerminalFocusProvider to avoid polling.
export type TerminalFocusState = 'focused' | 'blurred' | 'unknown'

let focusState: TerminalFocusState = 'unknown'
const resolvers: Set<() => void> = new Set()
const subscribers: Set<() => void> = new Set()

export function setTerminalFocused(v: boolean): void {
  focusState = v ? 'focused' : 'blurred'
  // Notify useSyncExternalStore subscribers
  for (const cb of subscribers) {
    cb()
  }
  if (!v) {
    for (const resolve of resolvers) {
      resolve()
    }
    resolvers.clear()
  }
}

export function getTerminalFocused(): boolean {
  return focusState !== 'blurred'
}

export function getTerminalFocusState(): TerminalFocusState {
  return focusState
}

// For useSyncExternalStore
export function subscribeTerminalFocus(cb: () => void): () => void {
  subscribers.add(cb)
  return () => {
    subscribers.delete(cb)
  }
}

export function resetTerminalFocusState(): void {
  focusState = 'unknown'
  for (const cb of subscribers) {
    cb()
  }
}