mirror of
https://github.com/zenorocha/clipboard.js.git
synced 2023-08-10 21:12:48 +03:00
Adds intro documentation
This commit is contained in:
parent
f7d3fb249a
commit
61f9e368b0
44
README.md
Normal file
44
README.md
Normal file
@ -0,0 +1,44 @@
|
||||
# clipboard.js
|
||||
|
||||
> A modern approach to copy & cut to the clipboard. No Flash. No dependencies. Just 1kb.
|
||||
|
||||
## Install
|
||||
|
||||
You can get it using bower:
|
||||
|
||||
```
|
||||
bower install clipboard --save
|
||||
```
|
||||
|
||||
Or [download as ZIP](https://github.com/zenorocha/clipboard.js/archive/master.zip).
|
||||
|
||||
## Usage
|
||||
|
||||
First, you need to instantiate it using a selector. This selector corresponds to the trigger element (usually a `<button>`).
|
||||
|
||||
```js
|
||||
new Clipboard('.btn');
|
||||
```
|
||||
|
||||
The easiest way to copy some content to the clipboard, is to include a `value` attribute in your trigger element.
|
||||
|
||||
```html
|
||||
<button class="btn" value="lorem ipsum">Copy</button>
|
||||
```
|
||||
|
||||
Another way of doing it is to copy the content from an `<input>` or `<textarea`>. You can do that by adding a `for` attribute in your trigger element. The value you include in this `for` attribute needs to match another's element `id` attribute.
|
||||
|
||||
```html
|
||||
<input id="target" value="Lorem ipsum">
|
||||
<button class="btn" for="target">Copy</button>
|
||||
```
|
||||
|
||||
## Browser Support
|
||||
|
||||
| <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/chrome/chrome_64x64.png" width="48px" height="48px" alt="Chrome logo"> | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/firefox/firefox_64x64.png" width="48px" height="48px" alt="Firefox logo"> | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/internet-explorer/internet-explorer_64x64.png" width="48px" height="48px" alt="Internet Explorer logo"> | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/opera/opera_64x64.png" width="48px" height="48px" alt="Opera logo"> | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/safari/safari_64x64.png" width="48px" height="48px" alt="Safari logo"> |
|
||||
|:---:|:---:|:---:|:---:|:---:|
|
||||
| 42+ ✔ | 41+ ✔ | 9+ ✔ | 29+ ✔ | ✘ |
|
||||
|
||||
## License
|
||||
|
||||
[MIT License](http://zenorocha.mit-license.org/) © Zeno Rocha
|
Loading…
Reference in New Issue
Block a user