eventsubscriber 2.1.3

A Flutter widget that updates (rebuilds) when an Event occurs.

Changelog - EventSubscriber

Version 2.1.3 (2022-01-11)

• Improvements to README
• Minor refactorings

Version 2.1.0 (2022-01-09)

• Breaking Change. The argument [handler] has been renamed to [builder] to be consistent with Flutter library APIs.
• The internal [ArgsBuilder] and [_ArgsWidgetBuilder] classes have been made private.
• Example application and test now works correctly.

Version 2.0.0 (2021-05-10)

• Updated for null safety
• A working Flutter example is provided in the example folder.

Version 1.2.1 (2020-02-17)

• The Event name in the example folder changed to show a standard Event Naming Pattern. In this pattern:-
  • Events are suffixed with 'Event' e.g. valueChangedEvent.
  • If there is the need to wrap the broadcasting of the event in a function containing some additional processing or validation, then one would do so in a function prefixed with 'on' e.g. onValueChanged.
    • The suffix 'Event' is removed from the 'on' function name.
    • The event is prefixed with an underscore ('_') to indicate that it is private and that the on.. method should be used to broadcast that the event has occurred.

    // Event Naming Pattern -  ..Event, on..
    var _valueChangedEvent = Event();
        
    void onValueChanged() {
      // Some processing or validation
      if (someImportantValue != null) {
        _valueChangedEvent.broadcast();
      }
    }
    
    // One would indicate that the event occurred ...
    onValueChanged()
    

Version 1.2.0 (2020-02-09)

• Breaking Change. Event arguments [EventArgs] are now supported.

  • The builder argument has been renamed to handler, to better reflect that you are supplying a subscriber handler that is called when the event is broadcast.
  • A handler requires now two arguments, the first representing the BuildContext, and the second the (optional) [EventArgs] associated with the Event.
    • before: builder: (context) => Text(myCount.value.toString()),
    • after: handler: (context, args) => Text(myCount.value.toString()),

  ...
  EventSubscriber(
    event: myCount.onValueChanged,
    handler: (context, args) => Text(myCount.value.toString()),
  
    // If an Event has arguments, they are now available in your handler.
    // In the example above through `args` argument.
  ),
  

  IMPORTANT: args should be checked for null before use in a handler, as the handler is called BOTH when an Event occurs, and also by the Flutter framework. In the latter case, args will always be null.

Version 1.1.2 (2020-01-31)

• Internal - don't repeat the event handler - refer to a single instance

Version 1.1.1 (2020-01-29)

• Support Event 1.1.0.
• Modified to use new Event methods - broadcast and subscribe.

Version 1.1.0 (2020-01-23)

• Breaking Change. Now supports subscribing to an Event instead of EventNotifier.
• Dependencies changed:
  • Dependency on EventNotifier removed.
  • Dependency on Event added.

Version 1.0.3 (2020-01-14)

• Updated to support latest EventNotifier (1.0.5), which includes support for a subscriber to optionally expect some 'argument/s' as a Map.

Version 1.0.2 (2020-01-13)

• Fixed LICENSE reference to package

Version 1.0.1 (2020-01-13)

• Fixed formatting and documentation errors.

Version 1.0.0 (2020-01-13)

• Initial release