While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.
clipboard.js lets you easily copy text to the clipboard. At 3kb gzipped and no need for Flash, it’s a great lightweight way to allow your visitors to copy bits of text and code on your site.
Install with npm
:
- npm install clipboard --save
Or get the package from Github and place the clipboard.min.js file manually in your project folder.
Then include the JavaScript file before the closing </body> tag:
<script src="path/to/clipboard.min.js"></script>
Finally, you’ll want to instantiate it. In the following JQuery example we’re instantiating the object for all elements with a class of clipboard
:
$( document ).ready(function() {
var clipboard = new Clipboard('.clipboard');
});
To use it, either use the data-clipboard-text
data attribute:
<button class="clipboard"
data-clipboard-text="This will be copied">
Copy this
</button>
Or use the data-clipboard-target
data attribute:
<span id="copy">This text will be copied</span>
Handle success and error states easily with the success and error custom events:
$( document ).ready(function() {
clipboard.on('success', function(e) {
$(e.trigger).text("Copied!");
e.clearSelection();
setTimeout(function() {
$(e.trigger).text("Copy");
}, 2500);
});
Note: Some browsers don’t support the execCommand API needed for clipboard.js to work properly. The text will still get selected, so a good workaround is to show a message telling the user to hit CTRL+C
when an error event is triggered.
Join our DigitalOcean community of over a million developers for free! Get help and share knowledge in our Questions & Answers section, find tutorials and tools that will help you grow as a developer and scale your project or business, and subscribe to topics of interest.
Sign upClick below to sign up and get $100 of credit to try our products over 60 days!