# browser-event-register

> [![codecov](https://codecov.io/gh/DisaPadla/browser-event-register/branch/master/graph/badge.svg)](https://codecov.io/gh/DisaPadla/browser-event-register) [![Build Status](https://travis-ci.com/DisaPadla/browser-event-register.svg?branch=master)](https://

Latest version **0.0.1** (published 2019-11-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install browser-event-register
pnpm add browser-event-register
yarn add browser-event-register
bun add browser-event-register
```

Provides the command `browser-event-register`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-11-27 |
| First published | 2019-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | DisaPadla |
| Maintainers | disapadla |
| Keywords | browser, event, custom event |

## Links

- npm: https://www.npmjs.com/package/browser-event-register
- Repository: https://github.com/DisaPadla/browser-event-register
- Homepage: https://github.com/DisaPadla/browser-event-register#readme
- Issues: https://github.com/DisaPadla/browser-event-register/issues
- npm.io page: https://npm.io/package/browser-event-register

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.0.1 (latest) — 2019-11-27

## README

# browser-event-register

[![codecov](https://codecov.io/gh/DisaPadla/browser-event-register/branch/master/graph/badge.svg)](https://codecov.io/gh/DisaPadla/browser-event-register)
[![Build Status](https://travis-ci.com/DisaPadla/browser-event-register.svg?branch=master)](https://travis-ci.com/DisaPadla/browser-event-register)

If you are not familiar with Custom Event click [here](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event) and [here](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent)

## Usage

Basic case:

```js
/* index.js in main app */

window.eventRegister = new EventRegister()

function updateCount() {
  // --------- some code ---------
}

window.eventRegister.add({
  type: 'update-count',
  listener: updateCount
})

/* some-another-file.js in sub-applicaction */

window.eventRegister.dispatch('update-count')
```

Pass own params on `dispatch`:

```js
window.eventRegister = new EventRegister()

function setData(e) {
  console.log(e.detail) // <-- your data is here
}

window.eventRegister.add({
  type: 'set-own-data',
  listener: setData
})

window.eventRegister.dispatch({
  type: 'set-own-data',
  options: {
    detail: { customData: 'customData' } // <-- it's necessary to pass "options.detail" property
  }
})
```

Pass optional Event fields (like "bubbles", "cancelable", "composed"):

```js
window.eventRegister = new EventRegister()

function setData(e) {
  // --------- some code ---------
}

window.eventRegister.add({
  type: 'set-own-data',
  listener: setData
})

window.eventRegister.dispatch({
  type: 'set-own-data',
  options: {
    bubbles: true,
    cancelable: true,
    composed: false
  }
})
```

Full Example (React):

```js
window.eventRegister = new EventRegister()

/* App.container.js  */
class App extends Component {
  state = { title: '' }

  componentDidMount() {
    window.eventRegister.add({
      type: 'ep-set-title',
      listener: this.setTitle
    })
  }

  componentWillUnmount() {
    window.eventRegister.remove({
      type: 'ep-set-title',
      listener: this.setTitle
    })
  }

  setTitle = e => this.setState({ title: e.detail })

  render() {
    return (
      <Template>
        <Title title={this.state.title} />
        <Content />
      </Template>
    )
  }
}
```

```js
/* AnotherApp.container.js  */

class AnotherApp extends Component {
  componentDidMount() {
    window.eventRegister.dispatch({
      type: 'ep-set-title',
      options: {
        detail: 'AnotherApp title',
      }
    });
  }

  render() {
    return (
      /* ------ some code ------ */
    )
  }
}
```

## eventRegister API

### `eventRegister.add({ type, listener, node?, options? })`

Add new listener for custom event

- `type`: string Required
- `listener`: function Required
- `node`: Node Optional (`document` by default)
- `options`: object Optional

### `eventRegister.dispatch(type | { type, options? })`

Dispatching an existing event type

- `type`: string Required
- `options`: object Optional

### `eventRegister.remove({ type, listener, options? })`

Removing an existing event type

- `type`: string Required
- `listener`: function Required
- `node`: Node Optional (`document` by default)
- `options`: object Optional

### `eventRegister.removeAllListenersByType(type)`

Removing all existing events by type

- `type`: string Required

---
_Source: https://npm.io/package/browser-event-register · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._