Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inndy/vue-clipboard2
A simple vue2 binding to clipboard.js
https://github.com/inndy/vue-clipboard2
clipboard copy vue vue2 vuejs vuejs2
Last synced: about 4 hours ago
JSON representation
A simple vue2 binding to clipboard.js
- Host: GitHub
- URL: https://github.com/inndy/vue-clipboard2
- Owner: Inndy
- License: mit
- Created: 2017-01-04T13:23:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T04:53:36.000Z (11 months ago)
- Last Synced: 2024-05-15T18:40:56.054Z (4 months ago)
- Topics: clipboard, copy, vue, vue2, vuejs, vuejs2
- Language: JavaScript
- Homepage: https://vue-clipboard2.inndy.tw/
- Size: 548 KB
- Stars: 1,767
- Watchers: 13
- Forks: 242
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-clipboard2
A simple vuejs 2 binding for clipboard.js
## DEPRECATED
I'm so grateful for all of you who have used and supported this project over the years.
It's been a fun ride, but it's time to say goodbye.
As of 2023, Vue2 is on its way out and the
[Clipboard API](https://caniuse.com/?search=clipboard.writeText) is now pretty much everywhere.
So you don't need this plugin anymore, just use `navigator.clipboard.writeText('text')`
and you're good to go. Thanks again for everything and happy coding!
## Install
`npm install --save vue-clipboard2` or use `dist/vue-clipboard.min.js` without webpack
## Usage
For vue-cli user:
```javascript
import Vue from 'vue'
import VueClipboard from 'vue-clipboard2'
Vue.use(VueClipboard)
```
For standalone usage:
```html
```
## I want to copy texts without a specific button!
Yes, you can do it by using our new method: `this.$copyText`. See
[sample2](https://github.com/Inndy/vue-clipboard2/blob/master/samples/sample2.html),
where we replace the clipboard directives with a v-on directive.
Modern browsers have some limitations like that you can't use `window.open` without a user interaction.
So there's the same restriction on copying things! Test it before you use it. Make sure you are not
using this method inside any async method.
Before using this feature, read:
[this issue](https://github.com/zenorocha/clipboard.js/issues/218) and
[this page](https://github.com/zenorocha/clipboard.js/wiki/Known-Limitations) first.
## It doesn't work with bootstrap modals
See [clipboardjs](https://clipboardjs.com/#advanced-usage) document and [this pull request](https://github.com/Inndy/vue-clipboard2/pull/23), `container` option is available like this:
```js
let container = this.$refs.container
this.$copyText("Text to copy", container)
```
Or you can let `vue-clipboard2` set `container` to current element by doing this:
```js
import Vue from 'vue'
import VueClipboard from 'vue-clipboard2'
VueClipboard.config.autoSetContainer = true // add this line
Vue.use(VueClipboard)
```
## Sample
```html
Copy!
new Vue({
el: '#app',
template: '#t',
data: function () {
return {
message: 'Copy These Text'
}
},
methods: {
onCopy: function (e) {
alert('You just copied: ' + e.text)
},
onError: function (e) {
alert('Failed to copy texts')
}
}
})
```
## Sample 2
```html
Copy!
new Vue({
el: '#app',
template: '#t',
data: function () {
return {
message: 'Copy These Text'
}
},
methods: {
doCopy: function () {
this.$copyText(this.message).then(function (e) {
alert('Copied')
console.log(e)
}, function (e) {
alert('Can not copy')
console.log(e)
})
}
}
})
```
You can use [your Vue instance ```vm.$el```](https://vuejs.org/v2/api/#vm-el) to get DOM elements via the usual traversal methods, e.g.:
```this.$el.children[1].children[2].textContent```
This will allow you to access the *rendered* content of your components, rather than the components themselves.
### Contribution
PRs welcome, and issues as well! If you want any feature that we don't have currently,
please fire an issue for a feature request.
### License
[MIT License](https://github.com/Inndy/vue-clipboard2/blob/master/LICENSE)