Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jkusa/ember-cli-clipboard
A simple ember wrapper around clipboard.js
https://github.com/jkusa/ember-cli-clipboard
clipboard ember ember-addon hacktoberfest
Last synced: 3 days ago
JSON representation
A simple ember wrapper around clipboard.js
- Host: GitHub
- URL: https://github.com/jkusa/ember-cli-clipboard
- Owner: jkusa
- License: mit
- Created: 2015-10-06T04:26:10.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T00:22:38.000Z (about 1 month ago)
- Last Synced: 2024-12-14T18:03:03.547Z (10 days ago)
- Topics: clipboard, ember, ember-addon, hacktoberfest
- Language: JavaScript
- Homepage: https://jkusa.github.io/ember-cli-clipboard
- Size: 4.69 MB
- Stars: 74
- Watchers: 5
- Forks: 37
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-clipboard
[](https://npmjs.org/package/ember-cli-clipboard)
[](https://github.com/jkusa/ember-cli-clipboard/actions?query=branch%3Amain)
[](http://emberobserver.com/addons/ember-cli-clipboard)
A simple ember wrapper around [clipboard.js](http://zenorocha.github.io/clipboard.js/) (no flash)
## Demo Page
http://jkusa.github.io/ember-cli-clipboard
## Usage
### CopyButton Component
```hbs
Click To Copy
Click To Copy
Click To Copy
```
#### Arguments
- `text` - string value or action that returns a string to be copied
- `target` - selector string of element or action that returns an element from which to copy text
- `action` - string value of operation: `copy` or `cut` (default is copy)
- `container` - selector string or element object of containing element. "For use in Bootstrap Modals or with any other library that changes the focus you'll want to set the focused element as the container value".
- `delegateClickEvent` - clipboard.js defaults event listeners to the body in order to reduce memory footprint if there are hundreds of event listeners on a page. If you want to scope the event listener to the copy button, set this property to `false`
- `buttonType` - string value of the button's [type attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#Attributes) (for Ember < `3.25.x`, see below)
Any HTML [button attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#Attributes) passed to the component will be "splatted" on the button element. The one exception to this is the `type` attribute due to this [issue](https://github.com/emberjs/ember.js/issues/18232) < Ember `3.25.x`.
#### Actions
The following clipboard.js custom events are sent as actions
- `onSuccess` sent on successful copy
- `onError` sent on failed copy
More information about the clipboard.js events can be found [here](https://github.com/zenorocha/clipboard.js/#events)
### Clipboard Element Modifier
Under the hood the `` component is powered by a `{{clipboard}}` element modifier. This can be used directly as an alternative to the `` component. It has the same argument contract as the `` component except for the exclusion of the `buttonType` argument.
```hbs
Click To Copy
```
### Template Helper
The helper `is-clipboard-supported` can be used to check if [clipboard.js](http://zenorocha.github.io/clipboard.js/) is supported or not.
```hbs
{{#if (is-clipboard-supported)}}
Click To Copy
{{/if}}
```
## Test Helpers
Some browsers do not allow simulated clicks to fire `execCommand('copy')`. This makes testing difficult. To assist with integration testing, the following test helpers are available to test the wiring of the `success` and `error` action handlers.
### Acceptance Test Helpers
- `triggerCopySuccess(selector='.copy-btn')`
- `triggerCopyError(selector='.copy-btn')`
```js
// tests/acceptance/my-test.js
import {
triggerCopyError,
triggerCopySuccess,
} from 'ember-cli-clipboard/test-support';
```
Example:
```js
// tests/acceptance/my-test.js
test('copy button message', async function (assert) {
assert.expect(3);
await visit('/');
assert.dom('.alert').doesNotExist('no alert message is initially present');
triggerCopySuccess();
assert
.dom('.alert.alert-success')
.exists('a success message is displayed when a copy is successful');
triggerCopyError();
assert
.dom('.alert.alert-info')
.exists('an error message is displayed when a copy is unsuccessful');
});
```
### Integration Test Helpers
- `triggerCopySuccess(selector='.copy-btn')`
- `triggerCopyError(selector='.copy-btn')`
Example:
```js
// tests/integration/components/my-test.js
// if using NEW ember testing api
import {
triggerCopyError,
triggerCopySuccess,
} from 'ember-cli-clipboard/test-support';
test('copy-button integration', async function (assert) {
assert.expect(2);
this.set('onSuccess', () => {
assert.ok(true, '`success` action handler correctly fired');
});
this.set('onError', () => {
assert.ok(true, '`error` action handler correctly fired');
});
await render(hbs`
Click To Copy
`);
//If using NEW ember testing api
triggerCopyError('.my-copy-btn');
triggerCopySuccess('.my-copy-btn');
});
```
## Browser Support
For browser support information, checkout the [clipboard.js](http://zenorocha.github.io/clipboard.js/) documentation:
https://github.com/zenorocha/clipboard.js/#browser-support
## Contributing
Contributions are welcomed. Please read the [contributing guidelines](CONTRIBUTING.md).
## License
This project is licensed under the [MIT License](LICENSE.md).