https://github.com/oliviertassinari/react-event-listener

A React component for binding events on the global scope. :dizzy:
https://github.com/oliviertassinari/react-event-listener

binding event listener react

Last synced: 5 months ago
JSON representation

A React component for binding events on the global scope. :dizzy:

• Host: GitHub
• URL: https://github.com/oliviertassinari/react-event-listener
• Owner: oliviertassinari
• License: mit
• Archived: true
• Created: 2015-06-08T22:31:30.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-02-02T11:22:02.000Z (over 6 years ago)
• Last Synced: 2025-04-22T22:07:33.328Z (6 months ago)
• Topics: binding, event, listener, react
• Language: JavaScript
• Homepage:
• Size: 456 KB
• Stars: 357
• Watchers: 6
• Forks: 36
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# react-event-listener

> A React component for binding events on the global scope.

[![npm version](https://img.shields.io/npm/v/react-event-listener.svg?style=flat-square)](https://www.npmjs.com/package/react-event-listener)

[![npm downloads](https://img.shields.io/npm/dm/react-event-listener.svg?style=flat-square)](https://www.npmjs.com/package/react-event-listener)

[![Build Status](https://travis-ci.org/oliviertassinari/react-event-listener.svg?branch=master)](https://travis-ci.org/oliviertassinari/react-event-listener)

[![Dependencies](https://img.shields.io/david/oliviertassinari/react-event-listener.svg?style=flat-square)](https://david-dm.org/oliviertassinari/react-event-listener)

[![DevDependencies](https://img.shields.io/david/dev/oliviertassinari/react-event-listener.svg?style=flat-square)](https://david-dm.org/oliviertassinari/react-event-listener#info=devDependencies&view=list)

## Installation

```sh

npm install react-event-listener

```

## The problem solved

This module provides a **declarative way** to bind events to a global `EventTarget`.

It's using the React lifecycle to bind and unbind at the right time.

## Usage

```js

import React, {Component} from 'react';

import EventListener, {withOptions} from 'react-event-listener';

class MyComponent extends Component {

  handleResize = () => {

    console.log('resize');

  };

  handleScroll = () => {

    console.log('scroll');

  };

  handleMouseMove = () => {

    console.log('mousemove');

  };

  render() {

    return (

      


        

        

      

    );

  }

}

```


### Note on server-side rendering

When doing server side rendering, `document` and `window` aren't available.

You can use a string as a `target`, or check that they exist before rendering

the component.

### Note on performance

You should avoid passing inline functions for listeners, because this creates a new `Function` instance on every

render, defeating `EventListener`'s `shouldComponentUpdate`, and triggering an update cycle where it removes its old

listeners and adds its new listeners (so that it can stay up-to-date with the props you passed in).

### Note on testing

In [this](https://github.com/facebook/react/issues/5043) issue from React, `TestUtils.Simulate.` methods won't bubble up to `window` or `document`. As a result, you must use [`document.dispatchEvent`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent) or simulate event using [native DOM api](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).

See our [test cases](https://github.com/oliviertassinari/react-event-listener/blob/master/src/index.spec.js) for more information.

## License

MIT