@react-hook/copy
v2.0.1
Published
A React hook for copying text to the clipboard
Downloads
11,310
Maintainers
Readme
A React hook for copying text to the clipboard
Quick Start
import useCopy from '@react-hook/copy'
const Component = (props) => {
const {copied, copy, reset} = useCopy(
'This text will be copied to the clipboard'
)
return <a onClick={copy}>{copied === false ? 'Copy' : 'Copied'}</a>
}
API
useCopy(text: string)
| Argument | Type | Required? | Description |
| -------- | -------- | --------- | ----------------------------------------------------------------- |
| text | string
| Yes | The text you want to copy to the clipboard when copy
is clicked |
Returns {copied: boolean, copy: () => void, reset: () => void}
LICENSE
MIT