Skip to content

useCopyToClipboard

Copies text to clipboard with toast feedback.

Signature

ts
function useCopyToClipboard(
  options?: UseCopyToClipboardOptions
): UseCopyToClipboardReturn

Parameters

UseCopyToClipboardOptions

PropertyTypeDefaultDescription
successMessagestring'Code copied!'Toast message on success
errorMessagestring'Unable to copy'Toast message on error
resetDelaynumber2000Milliseconds before copied resets to false

Return Type

UseCopyToClipboardReturn

PropertyTypeDescription
copy(text: string) => Promise<boolean>Copy text to clipboard
copiedbooleanWhether text was recently copied
errorError | nullError from last copy attempt

Example

tsx
const { copy, copied } = useCopyToClipboard()

<Button onClick={() => copy('Hello!')}>
  {copied ? 'Copied!' : 'Copy'}
</Button>

See also