Use Clipboard

Open-code aq-ui React hook for Use Clipboard.

Installation

pnpm dlx aq-ui@alpha add use-clipboard

Client module

Import the parts you need, then jump to an export for its contract.

"use client"

import { useClipboard } from "@/hooks/use-clipboard"

const result = useClipboard()

Type contract for ClipboardControls.

interface ClipboardControls

Name	Type
`copied`	`boolean`
`value`	`string \| undefined`
`error`	`unknown`
`supported`	`boolean`
`copy`	`(value: string) => Promise<boolean>`
`reset`	`() => void`

Open-code aq-ui React hook for Use Clipboard.

function useClipboard({ timeout = 2_000, }: UseClipboardOptions = {}): ClipboardControls

Name	Type	Default
`options?`	`UseClipboardOptions`	`{}`

const result = useClipboard()

Type contract for UseClipboardOptions.

interface UseClipboardOptions

Name	Type	Default
`timeout?`	`number`	`2_000`