CopyButton
Copies given text to clipboard
Import
Source
Docs
Package
Usage
CopyButton
is based on use-clipboard hook.
Its children is a function that receives an object with the following properties:
copied
– boolean value that indicates that given value was recently copied to clipboard, it resets after given timeout (defaults to 500ms)copy
– function that should be called to copy given value to clipboard
No iframes
Due to security reasons CopyButton
component will not work in iframes and may not work with local files opened with file://
protocol
(component will work fine with local websites that are using http://
protocol). You can learn more about navigator.clipboard
here.
Timeout
You can provide a custom copied
reset timeout
:
CopyButton component props
Name | Type | Description |
---|---|---|
children * | (payload: { copied: boolean; copy(): void; }) => ReactNode | Function called with current status |
timeout | number | Copied status timeout in ms |
value * | string | Value that should be copied to the clipboard |