custom-event-ts

custom-event-ts

A polyfill for CustomEvents on IE8+ written in Typescript

• written in Typescript
• fully tested
• auto polyfill CustomEvent when using
• offer GlobalEvent for easy use

一旦引用该组件，就会自动对 CustomEvent 进行 polyfill，同时提供组件 GlobalEvent 对象（默认导出）方便在全局进行自定义事件的订阅

参考文档

实现

• MDN - Custom Event：官网对自定义事件的说明
• custom-event-js：不仅有 polyfil，同时进一步有封装，方便不同库联调使用
• custom-event-polyfill： polyfill 库

教程

• 创建和触发 events：官网详细使用文档，推荐阅读
• javascript自定义事件功能与用法实例分析：详细讲解自定义事件的用法

Installation

Node.js / Browserify

npm install custom-event-ts --save

import GlobalEvent from "custom-event-ts";

// or
var GlobalEvent = require('custom-event-ts');

// Listen event 'SAY_HELLO'
GlobalEvent.on('SAY_HELLO', (data) => {
    console.log(data.detail) // { name: 'John' }
})

// Dispatch event 'SAY_HELLO' with data
GlobalEvent.dispatch('SAY_HELLO', { name: 'John' })

// Remove event listener
GlobalEvent.off('SAY_HELLO')

Global object

在页面中可以直接使用打包好的文件：

<script src="./dist/index.umd.min.js"></script>

通过 window.GlobaEvent 获取功能对象。

Build & test

npm run build

npm test

npm run doc

then open the generated out/index.html file in your browser.

License

MIT.