UseClipboardReturn

Defined in: src/hooks/useClipboard/useClipboard.types.ts:11

Properties

copied

copied: boolean

Defined in: src/hooks/useClipboard/useClipboard.types.ts:15

Convenience boolean — status === 'copied'.

---

copy()

copy: (text) => Promise<boolean>

Defined in: src/hooks/useClipboard/useClipboard.types.ts:19

Copy text to clipboard. Returns the resolved success boolean.

Parameters

text

string

Returns

Promise<boolean>

---

error

error: Error | null

Defined in: src/hooks/useClipboard/useClipboard.types.ts:17

Last error from a failed copy attempt, if any.

---

reset()

reset: () => void

Defined in: src/hooks/useClipboard/useClipboard.types.ts:21

Manually reset status to ‘idle’.

Returns

void

---

status

status: ClipboardStatus

Defined in: src/hooks/useClipboard/useClipboard.types.ts:13

Current state — flips to ‘copied’ for timeout ms after a successful copy.