Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xnimorz/subscribe-event
The easiest way to subscribe and unsubscribe to browser / node events
https://github.com/xnimorz/subscribe-event
capturing-events event-subscriber events subscriber subscription unsubscribe
Last synced: 19 days ago
JSON representation
The easiest way to subscribe and unsubscribe to browser / node events
- Host: GitHub
- URL: https://github.com/xnimorz/subscribe-event
- Owner: xnimorz
- License: mit
- Created: 2016-03-26T14:32:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T09:44:03.000Z (7 months ago)
- Last Synced: 2024-10-20T13:58:35.820Z (25 days ago)
- Topics: capturing-events, event-subscriber, events, subscriber, subscription, unsubscribe
- Language: JavaScript
- Homepage: http://xnimorz.github.io/subscribe-event/
- Size: 95.7 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Subscribe-event
Subscribe-event is the easiest way to subscribe either dom events in browser or node.js events.
Live example: http://xnimorz.github.io/subscribe-event/
#### Install
```
npm install --save subscribe-event
// or for yarn:
yarn add subscribe-event
```
Library support es6, CommonJs, AMD modules
#### Getting started
Step 1: import module:
```javascript
import subscribe from "subscribe-event";
```
Step 2: call subscrube function:
```javascript
const unsubscribe = subscribe(document, "scroll", () => {
/* Do some job */
});
```
Step 3: call unsubscibe, which returned from subscribe function, to dispose:
```javascipt
unsubscribe();
```
#### API
`subscribe` is a function, which receives 4 arguments:
1. element — is a HTMLElement such as document.body, document, etc., Node.js object or any another object, that triggers events.
2. event — is an event, such as `scroll`, `click`, `mousemove` etc.
3. eventCallback — a function called when event triggers
4. options — unessesary parameter, which provides more data to subscribe function. For example, when you using `subscribe` for HTMLElements you can capture events: `subscibe(document.querySelector('#a'), 'click', () => console.log('clicked'), true)`
#### Usage with React
```javascript
import React, { Component } from "react";
import subscribe from "subscribe-event";
class MyAmazingComponent extends Component {
componentDidMount() {
this.unsubscribeScroll = subscribe(document, "scroll", () => {
// do some job
});
}
componentWillUnmount() {
this.unsubscribeScroll();
}
render() {
const { children } = this.props;
return
{children};
}
}
```
Subscribe-event is useful for capturing events:
```javascript
import React, { Component } from "react";
import subscribe from "subscribe-event";
class MyAmazingComponent extends Component {
componentDidMount() {
this.unsubscribe = subscribe(
document,
"scroll",
() => {
// do some job
},
true
);
}
componentWillUnmount() {
this.unsubscribe();
}
render() {
const { children } = this.props;
return
{children};
}
}
```
#### Examples
For example in browser:
```javascript
import subscribe from "subscribe-event";
var element = document.querySelector(".my-button");
var unsubscribe = subscribe(element, "click", e => {
console.log(e);
});
// code
unsubscribe();
```
or
```javascript
import subscribe from "subscribe-event";
var unsubscribe = subscribe(document, "scroll", e => {
console.log(e);
});
// code
unsubscribe();
```
This library supports old ie also (attachEvent/detachEvent).
You can define your custom event subscribe function:
```javascript
import subscribe from 'subscribe-event';
var obj: {
eventSubscribe: function() {...},
eventUnsubscribe: function() {...}
}
var customSubscribe = subscribe.define('eventSubscribe', 'eventUnsubscribe');
var customUnsubscribe = customSubscribe(obj, event, handler);
// ...
customUnsubscribe();
```
By default subscribe-event works with: `addEventListener`, `detachEvent`, `on`