dom-event-listener - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "dom-event-listener",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Cross browser event listeners",
-  "main": "index.js",
+  "main": "lib/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha --recursive --require ./test/setup.js \"test/**/*@(.js)\""
   },
@@ -22,3 +22,3 @@ "repository": {
   "author": "Florian BARBARE",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
@@ -30,3 +30,10 @@ "url": "https://github.com/florian-barbare/dom-event-listener/issues"
     "lodash": "^4.13.1"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "jsdom": "^9.2.1",
+    "mocha": "^2.5.3",
+    "simulant": "^0.2.2",
+    "sinon": "^1.17.4"
   }
 }

README.md

 # dom-event-listener
 Cross browser event listener
 
-# ON GOING DEVELOPMENT, AVAILABLE IN A FEW DAYS
+> Cross-browser event listeners made out of the box.
+
+## Install
+
+Just get it from the npm.
+
+```
+npm i dom-event-listener --save
+```
+
+## Setup:
+
+###### Browserify
+
+```js
+var domEventListener = require('dom-event-listener');
+```
+
+###### ES6
+
+```js
+import domEventListener from 'dom-event-listener';
+```
+
+## Usage
+
+### Adding an event listener
+
+```js
+import domEventListener from 'dom-event-listener';
+
+let element = document.getElementById('my-element');
+
+domEventListener.add(element, 'click', function(event) {
+    console.log(event);
+});
+```
+
+### Removing an event listener
+
+```js
+import domEventListener from 'dom-event-listener';
+
+let element = document.getElementById('my-element');
+
+function onClick(event) {
+  console.log(event);
+}
+
+domEventListener.add(element, 'click', onClick);
+domEventListener.remove(element, 'click', onClick);
+```
+
+## Fancy keeping your scope?
+
+Pass an object with the handleEvent function
+
+```js
+import domEventListener from 'dom-event-listener';
+
+let element = document.getElementById('my-element');
+
+let object = {
+  value: 'some random value',
+  handleEvent: function (event) {
+    console.log(this.value);
+    console.log(event);
+  }
+};
+
+domEventListener.add(element, 'click', object);
+domEventListener.remove(element, 'click', object);
+```
+
+## 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"> |
+|:---:|:---:|:---:|:---:|:---:|
+| Latest ✔ | Latest ✔ | IE 8+ ✔ | Latest ✔ | Latest ✔ |
+
+## License
+
+[MIT License] © Florian Barbare

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12636

increased by112.26%

Number of package files

7

increased by40%

Number of low license alerts

0

decreased by-100%

Lines of code

218

increased by98.18%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

87

increased by1640%

Worsened metrics

Dev dependency count

5

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes