一个0.9kb简洁的事件订阅和发布Javascript库

onfire.js 是一个很简洁的事件分发,事件订阅和发布的Javascript库(仅仅 0.9kb),简洁实用。vue

Github地址:https://github.com/hustcc/onfire.jsreact

能够用于:git

  • 简单的事件分发;github

  • 在 react / vue.js / angular 用于跨组件的轻量级实现;npm

  • 事件订阅和发布;数组

在线示例,点击这里;English Version Readme. Click Hereui

Build Status npm npm npm

API 方法

1. on(event_name, callback)this

绑定事件,参数为 event_namecallback, 当有名字为event_name的事件发生的时候,callback方法将会被执行。spa

这个方法会返回一个eventObj,这个能够用于使用un(eventObj)方法来取消事件绑定。code

2. one(event_name, callback)

绑定(订阅)事件,参数为 event_name with callback. 当被触发一次以后失效。只能被触发一次,一次以后自动失效

3. fire(event_name, data)

触发名字为 event_name 的事件,而且赋予系列变量datascallback方法的输入值。

4. fireSync(event_name, data)

同步的方式触发名字为 event_name 的事件,而且赋予系列变量datascallback方法的输入值。

5. un(eventObj / event_name)

取消事件绑定。能够仅仅取消绑定一个事件回调方法,也能够直接取消所有的事件。

返回全部的事件名称数组。

6. clear()

清空全部事件。

使用的DEMO

1. 引入js文件

npm install onfire.js

可使用 <script> 标签直接引入; 也可使用 require 或者 import 关键字引入,会获得全局变量 onfire。

import onfire from 'onfire.js';

// or

var onfire = require("onfire.js");

2. 简单使用

使用方法 on 来订阅事件, 使用 un 来取消订阅, 使用 fire 方法来触发事件。

import onfire from 'onfire.js';

// 绑定事件
var eventObj = onfire.on('test_event', function(data1, data2) {
    console.log('this is a event 1');
});
var eventObj2 = onfire.on('test_event', function(data1, data2) {
    console.log('this is a event 2');
});

// 触发事件
onfire.fire('test_event', 'test_data1', 'test_data2');

// 取消绑定
onfire.un(eventObj); // 取消绑定这个事件.
onfire.un('test_event'); // 取消绑定全部的 `test_event`.

LICENSE

MIT

相关文章
相关标签/搜索