mirror
/
clipboard.js
mirror of https://github.com/zenorocha/clipboard.js.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update code style

This commit is contained in:
vitormalencar 2021-01-20 16:55:03 +01:00
parent 35688322f3
commit 2660565b61
19 changed files with 856 additions and 820 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.editorconfig
View File

@ -7,7 +7,7 @@ root = true
[*]
# Change these settings to your own preference
indent_style = space
indent_size = 4
indent_size = 2
# We recommend you to keep these unchanged
end_of_line = lf

6
bower.json
View File

@ -14,9 +14,5 @@
"/src",
"/lib"
],
"keywords": [
"clipboard",
"copy",
"cut"
]
"keywords": ["clipboard", "copy", "cut"]
}

1
contributing.md
View File

@ -24,5 +24,6 @@ Implement your bug fix or feature, write tests to cover it and make sure all tes
Documentation is extremely important and takes a fair deal of time and effort to write and keep updated. Please submit any and all improvements you can make to the repository's docs.
## Known issues
If you're using npm@3 you'll probably face some issues related to peerDependencies.
https://github.com/npm/npm/issues/9204

10
demo/constructor-node.html
View File

@ -1,9 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>constructor-node</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
@ -16,14 +16,14 @@
<!-- 3. Instantiate clipboard by passing a HTML element -->
<script>
var btn = document.getElementById('btn');
var btn = document.getElementById("btn");
var clipboard = new ClipboardJS(btn);
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

10
demo/constructor-nodelist.html
View File

@ -1,9 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>constructor-nodelist</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
@ -16,14 +16,14 @@
<!-- 3. Instantiate clipboard by passing a list of HTML elements -->
<script>
var btns = document.querySelectorAll('button');
var btns = document.querySelectorAll("button");
var clipboard = new ClipboardJS(btns);
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

10
demo/constructor-selector.html
View File

@ -1,9 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>constructor-selector</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
@ -16,13 +16,13 @@
<!-- 3. Instantiate clipboard by passing a string selector -->
<script>
var clipboard = new ClipboardJS('.btn');
var clipboard = new ClipboardJS(".btn");
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

14
demo/function-target.html
View File

@ -1,9 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>function-target</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
@ -15,17 +15,17 @@
<!-- 3. Instantiate clipboard -->
<script>
var clipboard = new ClipboardJS('.btn', {
var clipboard = new ClipboardJS(".btn", {
target: function () {
return document.querySelector('div');
}
return document.querySelector("div");
},
});
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

14
demo/function-text.html
View File

@ -1,9 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>function-text</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
@ -14,17 +14,17 @@
<!-- 3. Instantiate clipboard -->
<script>
var clipboard = new ClipboardJS('.btn', {
var clipboard = new ClipboardJS(".btn", {
text: function () {
return 'to be or not to be';
}
return "to be or not to be";
},
});
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

18
demo/target-div.html
View File

@ -1,27 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>target-div</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
<div>hello</div>
<button class="btn" data-clipboard-action="copy" data-clipboard-target="div">Copy</button>
<button
class="btn"
data-clipboard-action="copy"
data-clipboard-target="div"
>
Copy
</button>
<!-- 2. Include library -->
<script src="../dist/clipboard.min.js"></script>
<!-- 3. Instantiate clipboard -->
<script>
var clipboard = new ClipboardJS('.btn');
var clipboard = new ClipboardJS(".btn");
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

20
demo/target-input.html
View File

@ -1,27 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>target-input</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
<input id="foo" type="text" value="hello">
<button class="btn" data-clipboard-action="copy" data-clipboard-target="#foo">Copy</button>
<input id="foo" type="text" value="hello" />
<button
class="btn"
data-clipboard-action="copy"
data-clipboard-target="#foo"
>
Copy
</button>
<!-- 2. Include library -->
<script src="../dist/clipboard.min.js"></script>
<!-- 3. Instantiate clipboard -->
<script>
var clipboard = new ClipboardJS('.btn');
var clipboard = new ClipboardJS(".btn");
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

18
demo/target-textarea.html
View File

@ -1,27 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta charset="UTF-8" />
<title>target-textarea</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- 1. Define some markup -->
<textarea id="bar">hello</textarea>
<button class="btn" data-clipboard-action="cut" data-clipboard-target="#bar">Cut</button>
<button
class="btn"
data-clipboard-action="cut"
data-clipboard-target="#bar"
>
Cut
</button>
<!-- 2. Include library -->
<script src="../dist/clipboard.min.js"></script>
<!-- 3. Instantiate clipboard -->
<script>
var clipboard = new ClipboardJS('.btn');
var clipboard = new ClipboardJS(".btn");
clipboard.on('success', function(e) {
clipboard.on("success", function (e) {
console.log(e);
});
clipboard.on('error', function(e) {
clipboard.on("error", function (e) {
console.log(e);
});
</script>

29
karma.conf.js
View File

@ -1,30 +1,33 @@
var webpackConfig = require('./webpack.config.js');
var webpackConfig = require("./webpack.config.js");
module.exports = function (karma) {
karma.set({
plugins: ['karma-webpack', 'karma-chai', 'karma-sinon', 'karma-mocha', 'karma-chrome-launcher'],
frameworks: ['chai', 'sinon', 'mocha'],
files: [
'src/**/*.js',
'test/**/*.js',
plugins: [
"karma-webpack",
"karma-chai",
"karma-sinon",
"karma-mocha",
"karma-chrome-launcher",
],
frameworks: ["chai", "sinon", "mocha"],
files: ["src/**/*.js", "test/**/*.js"],
preprocessors: {
'src/**/*.js': ['webpack'],
'test/**/*.js': ['webpack']
"src/**/*.js": ["webpack"],
"test/**/*.js": ["webpack"],
},
webpack: {
module: webpackConfig.module,
plugins: webpackConfig.plugins
plugins: webpackConfig.plugins,
},
webpackMiddleware: {
stats: 'errors-only'
stats: "errors-only",
},
browsers: ['ChromeHeadless']
browsers: ["ChromeHeadless"],
});
};

2
package.js
View File

@ -4,7 +4,7 @@ Package.describe({
name: "zenorocha:clipboard",
summary: "Modern copy to clipboard. No Flash. Just 3kb.",
version: "2.0.6",
git: "https://github.com/zenorocha/clipboard.js"
git: "https://github.com/zenorocha/clipboard.js",
});
Package.onUse(function (api) {

47
readme.md
View File

@ -34,7 +34,7 @@ First, include the script located on the `dist` folder or load it from [a third-
Now, you need to instantiate it by [passing a DOM selector](https://github.com/zenorocha/clipboard.js/blob/master/demo/constructor-selector.html#L18), [HTML element](https://github.com/zenorocha/clipboard.js/blob/master/demo/constructor-node.html#L16-L17), or [list of HTML elements](https://github.com/zenorocha/clipboard.js/blob/master/demo/constructor-nodelist.html#L18-L19).
```js
new ClipboardJS('.btn');
new ClipboardJS(".btn");
```
Internally, we need to fetch all elements that matches with your selector and attach event listeners for each one. But guess what? If you have hundreds of matches, this operation can consume a lot of memory.
@ -55,11 +55,11 @@ The value you include on this attribute needs to match another's element selecto
```html
<!-- Target -->
<input id="foo" value="https://github.com/zenorocha/clipboard.js.git">
<input id="foo" value="https://github.com/zenorocha/clipboard.js.git" />
<!-- Trigger -->
<button class="btn" data-clipboard-target="#foo">
<img src="assets/clippy.svg" alt="Copy to clipboard">
<img src="assets/clippy.svg" alt="Copy to clipboard" />
</button>
```
@ -91,7 +91,10 @@ Truth is, you don't even need another element to copy its content from. You can
```html
<!-- Trigger -->
<button class="btn" data-clipboard-text="Just because you can doesn't mean you should — clipboard.js">
<button
class="btn"
data-clipboard-text="Just because you can doesn't mean you should — clipboard.js"
>
Copy to clipboard
</button>
```
@ -103,19 +106,19 @@ There are cases where you'd like to show some user feedback or capture what has
That's why we fire custom events such as `success` and `error` for you to listen and implement your custom logic.
```js
var clipboard = new ClipboardJS('.btn');
var clipboard = new ClipboardJS(".btn");
clipboard.on('success', function(e) {
console.info('Action:', e.action);
console.info('Text:', e.text);
console.info('Trigger:', e.trigger);
clipboard.on("success", function (e) {
console.info("Action:", e.action);
console.info("Text:", e.text);
console.info("Trigger:", e.trigger);
e.clearSelection();
});
clipboard.on('error', function(e) {
console.error('Action:', e.action);
console.error('Trigger:', e.trigger);
clipboard.on("error", function (e) {
console.error("Action:", e.action);
console.error("Trigger:", e.trigger);
});
```
@ -134,35 +137,35 @@ If you don't want to modify your HTML, there's a pretty handy imperative API for
For instance, if you want to dynamically set a `target`, you'll need to return a Node.
```js
new ClipboardJS('.btn', {
new ClipboardJS(".btn", {
target: function (trigger) {
return trigger.nextElementSibling;
}
},
});
```
If you want to dynamically set a `text`, you'll return a String.
```js
new ClipboardJS('.btn', {
new ClipboardJS(".btn", {
text: function (trigger) {
return trigger.getAttribute('aria-label');
}
return trigger.getAttribute("aria-label");
},
});
```
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.
```js
new ClipboardJS('.btn', {
container: document.getElementById('modal')
new ClipboardJS(".btn", {
container: document.getElementById("modal"),
});
```
Also, if you are working with single page apps, you may want to manage the lifecycle of the DOM more precisely. Here's how you clean up the events and objects that we create.
```js
var clipboard = new ClipboardJS('.btn');
var clipboard = new ClipboardJS(".btn");
clipboard.destroy();
```
@ -171,7 +174,7 @@ clipboard.destroy();
This library relies on both [Selection](https://developer.mozilla.org/en-US/docs/Web/API/Selection) and [execCommand](https://developer.mozilla.org/en-US/docs/Web/API/Document/execCommand) APIs. The first one is [supported by all browsers](https://caniuse.com/#search=selection) while the second one is supported in the following browsers.
| <img src="https://clipboardjs.com/assets/images/chrome.png" width="48px" height="48px" alt="Chrome logo"> | <img src="https://clipboardjs.com/assets/images/edge.png" width="48px" height="48px" alt="Edge logo"> | <img src="https://clipboardjs.com/assets/images/firefox.png" width="48px" height="48px" alt="Firefox logo"> | <img src="https://clipboardjs.com/assets/images/ie.png" width="48px" height="48px" alt="Internet Explorer logo"> | <img src="https://clipboardjs.com/assets/images/opera.png" width="48px" height="48px" alt="Opera logo"> | <img src="https://clipboardjs.com/assets/images/safari.png" width="48px" height="48px" alt="Safari logo"> |
|:---:|:---:|:---:|:---:|:---:|:---:|
| :-------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------: |
| 42+ ✔ | 12+ ✔ | 41+ ✔ | 9+ ✔ | 29+ ✔ | 10+ ✔ |
The good news is that clipboard.js gracefully degrades if you need to support older browsers. All you have to do is show a tooltip saying `Copied!` when `success` event is called and `Press Ctrl+C to copy` when `error` event is called because the text is already selected.
@ -180,7 +183,7 @@ You can also check if clipboard.js is supported or not by running `ClipboardJS.i
## Bonus
A browser extension that adds a "copy to clipboard" button to every code block on *GitHub, MDN, Gist, StackOverflow, StackExchange, npm, and even Medium.*
A browser extension that adds a "copy to clipboard" button to every code block on _GitHub, MDN, Gist, StackOverflow, StackExchange, npm, and even Medium._
Install for [Chrome](https://chrome.google.com/webstore/detail/codecopy/fkbfebkcoelajmhanocgppanfoojcdmg) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/codecopy/).

62
src/clipboard-action.js
View File

@ -1,4 +1,4 @@
import select from 'select';
import select from "select";
/**
* Inner class which performs selection from either `text` or `target`
@ -25,7 +25,7 @@ class ClipboardAction {
this.text = options.text;
this.trigger = options.trigger;
this.selectedText = '';
this.selectedText = "";
}
/**
@ -35,8 +35,7 @@ class ClipboardAction {
initSelection() {
if (this.text) {
this.selectFake();
}
else if (this.target) {
} else if (this.target) {
this.selectTarget();
}
}
@ -46,28 +45,30 @@ class ClipboardAction {
* and makes a selection on it.
*/
selectFake() {
const isRTL = document.documentElement.getAttribute('dir') == 'rtl';
const isRTL = document.documentElement.getAttribute("dir") == "rtl";
this.removeFake();
this.fakeHandlerCallback = () => this.removeFake();
this.fakeHandler = this.container.addEventListener('click', this.fakeHandlerCallback) || true;
this.fakeHandler =
this.container.addEventListener("click", this.fakeHandlerCallback) ||
true;
this.fakeElem = document.createElement('textarea');
this.fakeElem = document.createElement("textarea");
// Prevent zooming on iOS
this.fakeElem.style.fontSize = '12pt';
this.fakeElem.style.fontSize = "12pt";
// Reset box model
this.fakeElem.style.border = '0';
this.fakeElem.style.padding = '0';
this.fakeElem.style.margin = '0';
this.fakeElem.style.border = "0";
this.fakeElem.style.padding = "0";
this.fakeElem.style.margin = "0";
// Move element out of screen horizontally
this.fakeElem.style.position = 'absolute';
this.fakeElem.style[ isRTL ? 'right' : 'left' ] = '-9999px';
this.fakeElem.style.position = "absolute";
this.fakeElem.style[isRTL ? "right" : "left"] = "-9999px";
// Move element to the same position vertically
let yPosition = window.pageYOffset || document.documentElement.scrollTop;
this.fakeElem.style.top = `${yPosition}px`;
this.fakeElem.setAttribute('readonly', '');
this.fakeElem.setAttribute("readonly", "");
this.fakeElem.value = this.text;
this.container.appendChild(this.fakeElem);
@ -82,7 +83,7 @@ class ClipboardAction {
*/
removeFake() {
if (this.fakeHandler) {
this.container.removeEventListener('click', this.fakeHandlerCallback);
this.container.removeEventListener("click", this.fakeHandlerCallback);
this.fakeHandler = null;
this.fakeHandlerCallback = null;
}
@ -109,8 +110,7 @@ class ClipboardAction {
try {
succeeded = document.execCommand(this.action);
}
catch (err) {
} catch (err) {
succeeded = false;
}
@ -122,11 +122,11 @@ class ClipboardAction {
* @param {Boolean} succeeded
*/
handleResult(succeeded) {
this.emitter.emit(succeeded ? 'success' : 'error', {
this.emitter.emit(succeeded ? "success" : "error", {
action: this.action,
text: this.selectedText,
trigger: this.trigger,
clearSelection: this.clearSelection.bind(this)
clearSelection: this.clearSelection.bind(this),
});
}
@ -145,10 +145,10 @@ class ClipboardAction {
* Sets the `action` to be performed which can be either 'copy' or 'cut'.
* @param {String} action
*/
set action(action = 'copy') {
set action(action = "copy") {
this._action = action;
if (this._action !== 'copy' && this._action !== 'cut') {
if (this._action !== "copy" && this._action !== "cut") {
throw new Error('Invalid "action" value, use either "copy" or "cut"');
}
}
@ -168,18 +168,24 @@ class ClipboardAction {
*/
set target(target) {
if (target !== undefined) {
if (target && typeof target === 'object' && target.nodeType === 1) {
if (this.action === 'copy' && target.hasAttribute('disabled')) {
throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');
if (target && typeof target === "object" && target.nodeType === 1) {
if (this.action === "copy" && target.hasAttribute("disabled")) {
throw new Error(
'Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute'
);
}
if (this.action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {
throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');
if (
this.action === "cut" &&
(target.hasAttribute("readonly") || target.hasAttribute("disabled"))
) {
throw new Error(
'Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes'
);
}
this._target = target;
}
else {
} else {
throw new Error('Invalid "target" value, use a valid Element');
}
}

37
src/clipboard.js
View File

@ -1,6 +1,6 @@
import ClipboardAction from './clipboard-action';
import Emitter from 'tiny-emitter';
import listen from 'good-listener';
import ClipboardAction from "./clipboard-action";
import Emitter from "tiny-emitter";
import listen from "good-listener";
/**
* Base class which takes one or more elements, adds event listeners to them,
@ -24,10 +24,18 @@ class Clipboard extends Emitter {
* @param {Object} options
*/
resolveOptions(options = {}) {
this.action = (typeof options.action === 'function') ? options.action : this.defaultAction;
this.target = (typeof options.target === 'function') ? options.target : this.defaultTarget;
this.text = (typeof options.text === 'function') ? options.text : this.defaultText;
this.container = (typeof options.container === 'object') ? options.container : document.body;
this.action =
typeof options.action === "function"
? options.action
: this.defaultAction;
this.target =
typeof options.target === "function"
? options.target
: this.defaultTarget;
this.text =
typeof options.text === "function" ? options.text : this.defaultText;
this.container =
typeof options.container === "object" ? options.container : document.body;
}
/**
@ -35,7 +43,7 @@ class Clipboard extends Emitter {
* @param {String|HTMLElement|HTMLCollection|NodeList} trigger
*/
listenClick(trigger) {
this.listener = listen(trigger, 'click', (e) => this.onClick(e));
this.listener = listen(trigger, "click", (e) => this.onClick(e));
}
/**
@ -55,7 +63,7 @@ class Clipboard extends Emitter {
text: this.text(trigger),
container: this.container,
trigger: trigger,
emitter : this
emitter: this,
});
}
@ -64,7 +72,7 @@ class Clipboard extends Emitter {
* @param {Element} trigger
*/
defaultAction(trigger) {
return getAttributeValue('action', trigger);
return getAttributeValue("action", trigger);
}
/**
@ -72,7 +80,7 @@ class Clipboard extends Emitter {
* @param {Element} trigger
*/
defaultTarget(trigger) {
const selector = getAttributeValue('target', trigger);
const selector = getAttributeValue("target", trigger);
if (selector) {
return document.querySelector(selector);
@ -84,8 +92,8 @@ class Clipboard extends Emitter {
* given.
* @param {String} [action]
*/
static isSupported(action = ['copy', 'cut']) {
const actions = (typeof action === 'string') ? [action] : action;
static isSupported(action = ["copy", "cut"]) {
const actions = typeof action === "string" ? [action] : action;
let support = !!document.queryCommandSupported;
actions.forEach((action) => {
@ -100,7 +108,7 @@ class Clipboard extends Emitter {
* @param {Element} trigger
*/
defaultText(trigger) {
return getAttributeValue('text', trigger);
return getAttributeValue("text", trigger);
}
/**
@ -116,7 +124,6 @@ class Clipboard extends Emitter {
}
}
/**
* Helper function to retrieve attribute value.
* @param {String} suffix

155
test/clipboard-action.js
View File

@ -1,104 +1,105 @@
import ClipboardAction from '../src/clipboard-action';
import Emitter from 'tiny-emitter';
import ClipboardAction from "../src/clipboard-action";
import Emitter from "tiny-emitter";
describe('ClipboardAction', () => {
describe("ClipboardAction", () => {
before(() => {
global.input = document.createElement('input');
global.input.setAttribute('id', 'input');
global.input.setAttribute('value', 'abc');
global.input = document.createElement("input");
global.input.setAttribute("id", "input");
global.input.setAttribute("value", "abc");
document.body.appendChild(global.input);
global.paragraph = document.createElement('p');
global.paragraph.setAttribute('id', 'paragraph');
global.paragraph.textContent = 'abc';
global.paragraph = document.createElement("p");
global.paragraph.setAttribute("id", "paragraph");
global.paragraph.textContent = "abc";
document.body.appendChild(global.paragraph);
});
after(() => {
document.body.innerHTML = '';
document.body.innerHTML = "";
});
describe('#resolveOptions', () => {
it('should set base properties', () => {
describe("#resolveOptions", () => {
it("should set base properties", () => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
text: 'foo'
text: "foo",
});
assert.property(clip, 'action');
assert.property(clip, 'container');
assert.property(clip, 'emitter');
assert.property(clip, 'target');
assert.property(clip, 'text');
assert.property(clip, 'trigger');
assert.property(clip, 'selectedText');
assert.property(clip, "action");
assert.property(clip, "container");
assert.property(clip, "emitter");
assert.property(clip, "target");
assert.property(clip, "text");
assert.property(clip, "trigger");
assert.property(clip, "selectedText");
});
});
describe('#initSelection', () => {
it('should set the position right style property', done => {
describe("#initSelection", () => {
it("should set the position right style property", (done) => {
// Set document direction
document.documentElement.setAttribute('dir', 'rtl');
document.documentElement.setAttribute("dir", "rtl");
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
text: 'foo'
text: "foo",
});
assert.equal(clip.fakeElem.style.right, '-9999px');
assert.equal(clip.fakeElem.style.right, "-9999px");
done();
});
});
describe('#set action', () => {
it('should throw an error since "action" is invalid', done => {
describe("#set action", () => {
it('should throw an error since "action" is invalid', (done) => {
try {
new ClipboardAction({
text: 'foo',
action: 'paste'
text: "foo",
action: "paste",
});
}
catch(e) {
assert.equal(e.message, 'Invalid "action" value, use either "copy" or "cut"');
} catch (e) {
assert.equal(
e.message,
'Invalid "action" value, use either "copy" or "cut"'
);
done();
}
});
});
describe('#set target', () => {
it('should throw an error since "target" do not match any element', done => {
describe("#set target", () => {
it('should throw an error since "target" do not match any element', (done) => {
try {
new ClipboardAction({
target: document.querySelector('#foo')
target: document.querySelector("#foo"),
});
}
catch(e) {
} catch (e) {
assert.equal(e.message, 'Invalid "target" value, use a valid Element');
done();
}
});
});
describe('#selectText', () => {
it('should create a fake element and select its value', () => {
describe("#selectText", () => {
it("should create a fake element and select its value", () => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
text: 'blah'
text: "blah",
});
assert.equal(clip.selectedText, clip.fakeElem.value);
});
});
describe('#removeFake', () => {
it('should remove a temporary fake element', () => {
describe("#removeFake", () => {
it("should remove a temporary fake element", () => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
text: 'blah'
text: "blah",
});
clip.removeFake();
@ -107,81 +108,81 @@ describe('ClipboardAction', () => {
});
});
describe('#selectTarget', () => {
it('should select text from editable element', () => {
describe("#selectTarget", () => {
it("should select text from editable element", () => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
target: document.querySelector('#input')
target: document.querySelector("#input"),
});
assert.equal(clip.selectedText, clip.target.value);
});
it('should select text from non-editable element', () => {
it("should select text from non-editable element", () => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
target: document.querySelector('#paragraph')
target: document.querySelector("#paragraph"),
});
assert.equal(clip.selectedText, clip.target.textContent);
});
});
describe('#copyText', () => {
describe("#copyText", () => {
before(() => {
global.stub = sinon.stub(document, 'execCommand');
global.stub = sinon.stub(document, "execCommand");
});
after(() => {
global.stub.restore();
});
it('should fire a success event on browsers that support copy command', done => {
it("should fire a success event on browsers that support copy command", (done) => {
global.stub.returns(true);
let emitter = new Emitter();
emitter.on('success', () => {
emitter.on("success", () => {
done();
});
let clip = new ClipboardAction({
emitter,
target: document.querySelector('#input')
target: document.querySelector("#input"),
});
});
it('should fire an error event on browsers that support copy command', done => {
it("should fire an error event on browsers that support copy command", (done) => {
global.stub.returns(false);
let emitter = new Emitter();
emitter.on('error', () => {
emitter.on("error", () => {
done();
});
let clip = new ClipboardAction({
emitter,
target: document.querySelector('#input')
target: document.querySelector("#input"),
});
});
});
describe('#handleResult', () => {
it('should fire a success event with certain properties', done => {
describe("#handleResult", () => {
it("should fire a success event with certain properties", (done) => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
target: document.querySelector('#input')
target: document.querySelector("#input"),
});
clip.emitter.on('success', (e) => {
assert.property(e, 'action');
assert.property(e, 'text');
assert.property(e, 'trigger');
assert.property(e, 'clearSelection');
clip.emitter.on("success", (e) => {
assert.property(e, "action");
assert.property(e, "text");
assert.property(e, "trigger");
assert.property(e, "clearSelection");
done();
});
@ -189,17 +190,17 @@ describe('ClipboardAction', () => {
clip.handleResult(true);
});
it('should fire a error event with certain properties', done => {
it("should fire a error event with certain properties", (done) => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
target: document.querySelector('#input')
target: document.querySelector("#input"),
});
clip.emitter.on('error', (e) => {
assert.property(e, 'action');
assert.property(e, 'trigger');
assert.property(e, 'clearSelection');
clip.emitter.on("error", (e) => {
assert.property(e, "action");
assert.property(e, "trigger");
assert.property(e, "clearSelection");
done();
});
@ -208,12 +209,12 @@ describe('ClipboardAction', () => {
});
});
describe('#clearSelection', () => {
it('should remove focus from target and text selection', () => {
describe("#clearSelection", () => {
it("should remove focus from target and text selection", () => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
target: document.querySelector('#input')
target: document.querySelector("#input"),
});
clip.clearSelection();
@ -222,16 +223,16 @@ describe('ClipboardAction', () => {
let selectedText = window.getSelection().toString();
assert.equal(selectedElem, document.body);
assert.equal(selectedText, '');
assert.equal(selectedText, "");
});
});
describe('#destroy', () => {
it('should destroy an existing fake element', () => {
describe("#destroy", () => {
it("should destroy an existing fake element", () => {
let clip = new ClipboardAction({
emitter: new Emitter(),
container: document.body,
text: 'blah'
text: "blah",
});
clip.selectFake();

98
test/clipboard.js
View File

@ -1,127 +1,129 @@
import Clipboard from '../src/clipboard';
import ClipboardAction from '../src/clipboard-action';
import listen from 'good-listener';
import Clipboard from "../src/clipboard";
import ClipboardAction from "../src/clipboard-action";
import listen from "good-listener";
describe('Clipboard', () => {
describe("Clipboard", () => {
before(() => {
global.button = document.createElement('button');
global.button.setAttribute('class', 'btn');
global.button.setAttribute('data-clipboard-text', 'foo');
global.button = document.createElement("button");
global.button.setAttribute("class", "btn");
global.button.setAttribute("data-clipboard-text", "foo");
document.body.appendChild(global.button);
global.span = document.createElement('span');
global.span.innerHTML = 'bar';
global.span = document.createElement("span");
global.span.innerHTML = "bar";
global.button.appendChild(span);
global.event = {
target: global.button,
currentTarget: global.button
currentTarget: global.button,
};
});
after(() => {
document.body.innerHTML = '';
document.body.innerHTML = "";
});
describe('#resolveOptions', () => {
describe("#resolveOptions", () => {
before(() => {
global.fn = () => {};
});
it('should set action as a function', () => {
let clipboard = new Clipboard('.btn', {
action: global.fn
it("should set action as a function", () => {
let clipboard = new Clipboard(".btn", {
action: global.fn,
});
assert.equal(global.fn, clipboard.action);
});
it('should set target as a function', () => {
let clipboard = new Clipboard('.btn', {
target: global.fn
it("should set target as a function", () => {
let clipboard = new Clipboard(".btn", {
target: global.fn,
});
assert.equal(global.fn, clipboard.target);
});
it('should set text as a function', () => {
let clipboard = new Clipboard('.btn', {
text: global.fn
it("should set text as a function", () => {
let clipboard = new Clipboard(".btn", {
text: global.fn,
});
assert.equal(global.fn, clipboard.text);
});
it('should set container as an object', () => {
let clipboard = new Clipboard('.btn', {
container: document.body
it("should set container as an object", () => {
let clipboard = new Clipboard(".btn", {
container: document.body,
});
assert.equal(document.body, clipboard.container);
});
it('should set container as body by default', () => {
let clipboard = new Clipboard('.btn');
it("should set container as body by default", () => {
let clipboard = new Clipboard(".btn");
assert.equal(document.body, clipboard.container);
});
});
describe('#listenClick', () => {
it('should add a click event listener to the passed selector', () => {
let clipboard = new Clipboard('.btn');
describe("#listenClick", () => {
it("should add a click event listener to the passed selector", () => {
let clipboard = new Clipboard(".btn");
assert.isObject(clipboard.listener);
});
});
describe('#onClick', () => {
it('should create a new instance of ClipboardAction', () => {
let clipboard = new Clipboard('.btn');
describe("#onClick", () => {
it("should create a new instance of ClipboardAction", () => {
let clipboard = new Clipboard(".btn");
clipboard.onClick(global.event);
assert.instanceOf(clipboard.clipboardAction, ClipboardAction);
});
it('should use an event\'s currentTarget when not equal to target', () => {
let clipboard = new Clipboard('.btn');
let bubbledEvent = { target: global.span, currentTarget: global.button };
it("should use an event's currentTarget when not equal to target", () => {
let clipboard = new Clipboard(".btn");
let bubbledEvent = {
target: global.span,
currentTarget: global.button,
};
clipboard.onClick(bubbledEvent);
assert.instanceOf(clipboard.clipboardAction, ClipboardAction);
});
it('should throw an exception when target is invalid', done => {
it("should throw an exception when target is invalid", (done) => {
try {
const clipboard = new Clipboard('.btn', {
const clipboard = new Clipboard(".btn", {
target() {
return null;
}
},
});
clipboard.onClick(global.event);
}
catch(e) {
} catch (e) {
assert.equal(e.message, 'Invalid "target" value, use a valid Element');
done();
}
});
});
describe('#static isSupported', () => {
it('should return the support of the given action', () => {
assert.equal(Clipboard.isSupported('copy'), true);
assert.equal(Clipboard.isSupported('cut'), true);
describe("#static isSupported", () => {
it("should return the support of the given action", () => {
assert.equal(Clipboard.isSupported("copy"), true);
assert.equal(Clipboard.isSupported("cut"), true);
});
it('should return the support of the cut and copy actions', () => {
it("should return the support of the cut and copy actions", () => {
assert.equal(Clipboard.isSupported(), true);
});
});
describe('#destroy', () => {
it('should destroy an existing instance of ClipboardAction', () => {
let clipboard = new Clipboard('.btn');
describe("#destroy", () => {
it("should destroy an existing instance of ClipboardAction", () => {
let clipboard = new Clipboard(".btn");
clipboard.onClick(global.event);
clipboard.destroy();

45
webpack.config.js
View File

@ -1,9 +1,9 @@
const pkg = require('./package.json');
const path = require('path');
const webpack = require('webpack');
const UglifyJSPlugin = require('uglifyjs-webpack-plugin');
const pkg = require("./package.json");
const path = require("path");
const webpack = require("webpack");
const UglifyJSPlugin = require("uglifyjs-webpack-plugin");
const production = process.env.NODE_ENV === 'production' || false;
const production = process.env.NODE_ENV === "production" || false;
const banner = `clipboard.js v${pkg.version}
https://clipboardjs.com/
@ -11,36 +11,35 @@ https://clipboardjs.com/
Licensed MIT © Zeno Rocha`;
module.exports = {
entry: './src/clipboard.js',
mode: 'production',
entry: "./src/clipboard.js",
mode: "production",
output: {
filename: production ? 'clipboard.min.js' : 'clipboard.js',
path: path.resolve(__dirname, 'dist'),
library: 'ClipboardJS',
globalObject: 'this',
libraryExport: 'default',
libraryTarget: 'umd'
filename: production ? "clipboard.min.js" : "clipboard.js",
path: path.resolve(__dirname, "dist"),
library: "ClipboardJS",
globalObject: "this",
libraryExport: "default",
libraryTarget: "umd",
},
module: {
rules: [
{test: /\.js$/, exclude: /node_modules/, loader: 'babel-loader'}
]
rules: [{ test: /\.js$/, exclude: /node_modules/, loader: "babel-loader" }],
},
optimization: {
minimize: production,
minimizer: [
new UglifyJSPlugin({
parallel: require('os').cpus().length,
parallel: require("os").cpus().length,
uglifyOptions: {
ie8: false,
keep_fnames: false,
output: {
beautify: false,
comments: (node, {value, type}) => type == 'comment2' && value.startsWith('!')
}
}
})
]
comments: (node, { value, type }) =>
type == "comment2" && value.startsWith("!"),
},
plugins: [new webpack.BannerPlugin({ banner })]
},
}),
],
},
plugins: [new webpack.BannerPlugin({ banner })],
};