useClipboard
Reads and copies text from the clipboard.
Usage
import { useClipboard } from "@siberiacancode/reactuse";
const clipboard = useClipboard();Example
Copy button:
const clipboard = useClipboard();
return (
<button onClick={() => clipboard.copy("team@example.com")}>
{clipboard.value ?? "Copy email"}
</button>
);enabled (track copy/cut events):
const clipboard = useClipboard({ enabled: true });Notes
- Hook uses the navigator.clipboard API.
Type Declarations
export interface UseCopyToClipboardReturn {
value: string | null;
copy: (value: string) => Promise<void>;
}
export interface UseCopyToClipboardParams {
enabled: boolean;
}
export declare const useClipboard: (
params?: UseCopyToClipboardParams
) => UseCopyToClipboardReturn;