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.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
Alligator.io is a developer-focused resource that offers tutorials and insights on a wide range of modern front-end technologies, including Angular 2+, Vue.js, React, TypeScript, Ionic, and JavaScript.
This textbox defaults to using Markdown to format your answer.
You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!
Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.
Full documentation for every DigitalOcean product.
The Wave has everything you need to know about building a business, from raising funding to marketing your product.
Stay up to date by signing up for DigitalOcean’s Infrastructure as a Newsletter.
New accounts only. By submitting your email you agree to our Privacy Policy
Scale up as you grow — whether you're running one virtual machine or ten thousand.
Sign up and get $200 in credit for your first 60 days with DigitalOcean.*
*This promotional offer applies to new accounts only.