simple-react-clipboard
v1.0.5
Published
A simple and flexible React utility component for copying texts to the clipboard.
Downloads
5,220
Readme
Simple React Clipboard
A simple and flexible React utility component for copying texts to the clipboard. Some code is based on clipboard.js.
Getting Started
npm i simple-react-clipboard
The component passed in the render
prop will have the copy
function passed in as a prop.
The copy
function will copy the text
prop to the clipboard.
import React from "react";
import Clipboard from "simple-react-clipboard";
const Demo = () => (
<Clipboard
text={"Copy on Button Click"}
render={({copy}) => <button onClick={copy}>Copy</button>}
/>
)
export default Demo;
Sample Code
Demo and sample code can be found here.
Props
Name | Type | Description | Required
--- | --- | --- | ---
render
| function
| A function that returns a React element. | Y
text
| string
| The text to be copied when copy
is called. | Y
props
| object
| props
to pass to the component in render
| N
onSuccess
| function
| Function called when copy
succeeds. | N
onError
| function
| Function called when copy
fails. | N
To Run this Repository
git clone https://github.com/donfour/simple-react-clipboard.git
npm install
npm run dev
To Test this Repository
npm run test