useCopyToClipboard() — ui Function Reference

Architecture documentation for the useCopyToClipboard() function in use-copy-to-clipboard.ts from the ui codebase.

Function typescript ComponentRegistry Styles

Entity Profile

ComponentRegistry→ Styles→ useCopyToClipboard() — ui Function Reference

Dependency Diagram

graph TD
  2bdd2743_43cf_ec9b_5e53_63ce4ca9b234["useCopyToClipboard()"]
  7ac47faf_ec86_a724_0046_b9bb3cf05458["use-copy-to-clipboard.ts"]
  2bdd2743_43cf_ec9b_5e53_63ce4ca9b234 -->|defined in| 7ac47faf_ec86_a724_0046_b9bb3cf05458
  style 2bdd2743_43cf_ec9b_5e53_63ce4ca9b234 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

deprecated/www/hooks/use-copy-to-clipboard.ts lines 5–35

export function useCopyToClipboard({
  timeout = 2000,
  onCopy,
}: {
  timeout?: number
  onCopy?: () => void
} = {}) {
  const [isCopied, setIsCopied] = React.useState(false)

  const copyToClipboard = (value: string) => {
    if (typeof window === "undefined" || !navigator?.clipboard?.writeText) {
      return
    }

    if (!value) return

    navigator.clipboard.writeText(value).then(() => {
      setIsCopied(true)

      if (onCopy) {
        onCopy()
      }

      setTimeout(() => {
        setIsCopied(false)
      }, timeout)
    }, console.error)
  }

  return { isCopied, copyToClipboard }
}