copyToClipboard

A helper function that helps you copy things to clipboard on click.

Import


import { copyToClipboard } from '@octopus-energy/utils';

Usage


const [valueCopied, setValueCopied] = useState<boolean>(false);
 
useEffect(() => {
    if (valueCopied) {
        const timeout = setTimeout(() => {
            setValueCopied(false);
        }, 2000);
 
        return () => clearTimeout(timeout);
    }
}, [valueCopied]);
 
<button
    onClick={() =>
        copyToClipboard('octo.ps/1234567890', () => setValueCopied(true))
    }
>
    {!valueCopied ? 'Copy link' : 'Copied!'}
</button>

Args

Name	Description	Type	Required
value	The value to copy to clipboard.	`string`	`true`
onSuccess	A callback function to run if the copy event succeeds.	`Function`	`false`
onError	A callback function to run if the copy event fails.	`Function`	`false`