From e88f0ceb8a17f97b4f047bed1760cc8873f45388 Mon Sep 17 00:00:00 2001 From: Ward Oosterlijnck Date: Mon, 2 Sep 2019 23:15:37 +1000 Subject: [PATCH] docs: fix and improve useCopyToClipboard documentation --- docs/useCopyToClipboard.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/docs/useCopyToClipboard.md b/docs/useCopyToClipboard.md index f94acbc7..825db3c9 100644 --- a/docs/useCopyToClipboard.md +++ b/docs/useCopyToClipboard.md @@ -18,22 +18,15 @@ const Demo = () => { : state.value &&

Copied {state.value}

} ) - - const [text, setText] = React.useState(''); - const [copied, copyToClipboard] = useCopyToClipboard(text); - - return ( -
- setText(e.target.value)} /> - -
Copied: {copied ? 'Yes' : 'No'}
-
- ) } ``` ## Reference ```js -const [state, copyToClipboard] = useCopyToClipboard(); +const [{value, error, noUserInteraction}, copyToClipboard] = useCopyToClipboard(); ``` + +- `value` — value that was copied to clipboard, undefined when nothing was copied. +- `error` — catched error when trying to copy to clipboard. +- `noUserInteraction` — 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.