archive-gh-me/react-use
1
0
Fork 0
mirror of https://github.com/streamich/react-use.git synced 2026-01-25 14:17:16 +00:00
Code Issues Projects Releases Wiki Activity

docs: fix and improve useCopyToClipboard documentation

Browse Source
This commit is contained in:
Ward Oosterlijnck 2019-09-02 23:15:37 +10:00
parent 1ee1cb90b9
commit e88f0ceb8a
1 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/useCopyToClipboard.md
View File

@ -18,22 +18,15 @@ const Demo = () => {
: state.value && <p>Copied {state.value}</p>}
</div>
)
const [text, setText] = React.useState('');
const [copied, copyToClipboard] = useCopyToClipboard(text);
return (
<div>
<input value={text} onChange={e => setText(e.target.value)} />
<button type="button" onClick={copyToClipboard}>copy text</button>
<div>Copied: {copied ? 'Yes' : 'No'}</div>
</div>
)
}
```
## Reference
```js
const [state, copyToClipboard] = useCopyToClipboard();
const [{value, error, noUserInteraction}, copyToClipboard] = useCopyToClipboard();
```
- `value` &mdash; value that was copied to clipboard, undefined when nothing was copied.
- `error` &mdash; catched error when trying to copy to clipboard.
- `noUserInteraction` &mdash; boolean indicating if user interaction was required to copy the value to clipboard to expose full API from underlying [`copy-to-clipboard`](https://github.com/sudodoki/copy-to-clipboard) library.