Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeroclipboard/zeroclipboard
The ZeroClipboard library provides an easy way to copy text to the clipboard using an invisible Adobe Flash movie and a JavaScript interface.
https://github.com/zeroclipboard/zeroclipboard
adobe-flash adobe-flex apache-flex clipboard dom flash frontend javascript web zeroclipboard
Last synced: 3 months ago
JSON representation
The ZeroClipboard library provides an easy way to copy text to the clipboard using an invisible Adobe Flash movie and a JavaScript interface.
- Host: GitHub
- URL: https://github.com/zeroclipboard/zeroclipboard
- Owner: zeroclipboard
- License: mit
- Archived: true
- Created: 2012-04-13T03:59:44.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2021-02-15T20:36:42.000Z (almost 4 years ago)
- Last Synced: 2024-05-17T11:01:37.946Z (7 months ago)
- Topics: adobe-flash, adobe-flex, apache-flex, clipboard, dom, flash, frontend, javascript, web, zeroclipboard
- Language: JavaScript
- Homepage: http://zeroclipboard.github.io/
- Size: 3.08 MB
- Stars: 6,616
- Watchers: 252
- Forks: 1,048
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: docs/security.md
Awesome Lists containing this project
- awesome - zeroclipboard / zeroclipboard
README
### :warning: WARNING!
This library is no longer maintained as it is no longer necessary for modern web development. If you want your frontend JavaScript to manipulate the clipboard, please look into the new HTML Clipboard API (various docs available on MDN) or a small convenience wrapper around it like [clipboard.js](https://github.com/zenorocha/clipboard.js). Thanks for all your support, this project was a labor of love for many years. :heart:
---
#### Note:
**This `master` branch contains the `v2.x` codebase for ZeroClipboard! For the `v1.x` codebase, see the [`1.x-master`](https://github.com/zeroclipboard/zeroclipboard/tree/1.x-master) branch instead.**
# ZeroClipboard
[](https://github.com/zeroclipboard/zeroclipboard) [](https://travis-ci.org/zeroclipboard/zeroclipboard)  [](https://coveralls.io/r/zeroclipboard/zeroclipboard?branch=master) [](https://david-dm.org/zeroclipboard/zeroclipboard) [](https://david-dm.org/zeroclipboard/zeroclipboard#info=devDependencies)
The ZeroClipboard library provides an easy way to copy text to the clipboard using an invisible [Adobe Flash](http://en.wikipedia.org/wiki/Adobe_Flash) movie and a [JavaScript](http://en.wikipedia.org/wiki/JavaScript) interface. The "Zero" signifies that the library is invisible and the user interface is left entirely up to you.
This is achieved by automatically floating the invisible movie on top of a [DOM](http://en.wikipedia.org/wiki/Document_Object_Model) element of your choice. Standard mouse events are even propagated out to your DOM element, so you can still have rollover and mousedown effects.
Suggestions welcome read over the [contributing](/CONTRIBUTING.md) guidelines.
## Setup
To setup the project for local development start with these commands in your terminal.
```sh
$ git clone https://github.com/zeroclipboard/zeroclipboard.git
$ cd zeroclipboard/
$ npm install -g grunt-cli
$ npm install
$ grunt
```
## Development
Before submitting a pull request you'll need to validate, build, and test your code. Run the default grunt task in your terminal.
```sh
$ grunt
```
## Testing
If you just want to run the tests, run grunt test.
```sh
$ grunt test
```
## Limitations
### User Interaction Required
Due to browser and Flash security restrictions, this clipboard injection can _**ONLY**_ occur when
the user clicks on the invisible Flash movie. A simulated `click` event from JavaScript will not
suffice as this would enable [clipboard poisoning](http://www.computerworld.com/s/article/9117268/Adobe_patches_Flash_clickjacking_and_clipboard_poisoning_bugs).
### Other Limitations
For a complete list of limitations, see [docs/instructions.md#limitations](docs/instructions.md#limitations).
On that page, you will also find an [explanation of why ZeroClipboard will _NOT_ work by default on code playground sites](docs/instructions.md#starter-snippets-for-playground-sites) like JSFiddle, JSBin, and CodePen, as well as the appropriate "View" URLs to use on those sites in order to allow ZeroClipboard to work.
## Simple Example
```html
Copy to Clipboard
```
```js
// main.js
var client = new ZeroClipboard( document.getElementById("copy-button") );
client.on( "ready", function( readyEvent ) {
// alert( "ZeroClipboard SWF is ready!" );
client.on( "aftercopy", function( event ) {
// `this` === `client`
// `event.target` === the element that was clicked
event.target.style.display = "none";
alert("Copied text to clipboard: " + event.data["text/plain"] );
} );
} );
```
See [docs/instructions.md](docs/instructions.md) for more advanced options in using the library on your site.
See [docs/api/ZeroClipboard.md](docs/api/ZeroClipboard.md) for the complete API documentation.
Here is a working [test page](http://zeroclipboard.github.io/#demo) where you can try out ZeroClipboard in your browser.
## Testing ZeroClipboard Locally
To test the page [demo page](http://zeroclipboard.github.io/#demo) locally, clone the [website repo](https://github.com/zeroclipboard/zeroclipboard.github.io).
## Support
This library is fully compatible with Flash Player 11.0.0 and above, which requires
that the clipboard copy operation be initiated by a user click event inside the
Flash movie. This is achieved by automatically floating the invisible movie on top
of a [DOM](http://en.wikipedia.org/wiki/Document_Object_Model) element of your
choice. Standard mouse events are even propagated out to your DOM element, so you
can still have rollover and mousedown effects with just a _little_ extra effort.
ZeroClipboard `v2.x` is expected to work in IE9+ and all of the evergreen browsers.
Although support for IE7 & IE8 was officially dropped in `v2.0.0`, it was actually
still _technically_ supported through `v2.0.2`.
## Releases
Starting with version [1.1.7](https://github.com/zeroclipboard/zeroclipboard/releases/tag/v1.1.7), ZeroClipboard uses [semantic versioning](http://semver.org/).
see [releases](https://github.com/zeroclipboard/zeroclipboard/releases)
## Related
* [jquery.zeroclipboard](https://github.com/zeroclipboard/jquery.zeroclipboard)
* [zeroclipboard-rails](https://github.com/zeroclipboard/zeroclipboard-rails)
## License
MIT © [James M. Greene](http://greene.io/) [Jon Rohan](http://jonrohan.codes)