title: Event mechanism

Taro provides Taro.Events to implement the event mechanism, which needs to be instantiated for use, as follows:

  1. import Taro, { Events } from '@tarojs/taro'
  3. const events = new Events()
  5. // Listening for an event, accepting parameters
  6. events.on('eventName', (arg) => {
  7.   // doSth
  8. })
  10. // Listening to the same event and binding multiple handlers at the same time
  11. events.on('eventName', handler1)
  12. events.on('eventName', handler2)
  13. events.on('eventName', handler3)
  15. // Trigger an event, pass the reference
  16. events.trigger('eventName', arg)
  18. // Trigger an event, pass in multiple parameters
  19. events.trigger('eventName', arg1, arg2, ...)
  21. // Unlisten to an event
  22. events.off('eventName')
  24. // Cancel a handler that listens to an event
  25. events.off('eventName', handler1)
  27. // Unlisten to all events
  28. events.off()

Taro also implements the global message centre (Taro.eventCenter), which is an instance of Taro.Events.

  1. import Taro from '@tarojs/taro'
  3. Taro.eventCenter.on
  4. Taro.eventCenter.trigger
  5. Taro.eventCenter.off