1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/hustcc-onfire.js

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
README_zh.md 3.7 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 26.11.2024 12:24 01ada72

onfire.js — это простая библиотека для рассылки событий на JavaScript, размером всего лишь 0,9 КБ, компактная и практичная.

Может использоваться:

  • для простой рассылки событий;
  • в React, Vue.js и Angular для облегчённой реализации между компонентами;
  • для подписки и публикации событий.

Онлайн-пример доступен по ссылке здесь.

Английская версия Readme доступна по ссылке Readme.md.

API методы:

  1. on(event_name, callback, context) — связывает событие. Параметры: event_name и callback. Когда происходит событие с именем event_name, выполняется метод callback. Этот метод возвращает eventObj, который можно использовать с методом un(eventObj) для отмены привязки события.
  2. one(event_name, callback, context) — привязывает (подписывает) событие. Параметр: event_name с callback. Утрачивает силу после однократного срабатывания. Может быть вызвано только один раз, после чего автоматически утрачивает силу.
  3. fire(event_name, data1, data2, ...) — асинхронно вызывает событие с именем event_name и присваивает ряд переменных datas в качестве входных значений метода callback.
  4. fireSync(event_name, data1, data2, ...) — синхронно вызывает событие с именем event_name и присваивает ряд переменных datas в качестве входных значений метода callback. Блокирует выполнение.
  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");
  1. Простое использование.
    • Используйте метод on для подписки на событие, un для отмены подписки, fire для запуска события.
import onfire from 'onfire.js';

function test_callback(data1, data2) {
	console.log('this is a event 1');
}

// Привязка события
var eventObj = onfire.on('test_event', test_callback);
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'.
onfire.un(test_callback); // Отменяет привязку всех методов test_callback.

Лицензия: MIT.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/hustcc-onfire.js.git
git@api.gitlife.ru:oschina-mirror/hustcc-onfire.js.git
oschina-mirror
hustcc-onfire.js
hustcc-onfire.js
master