get_it_mixin 4.2.2

get_it_mixin: ^4.2.2 copied to clipboard

• pushScope now gives the new scope a unique name, that is used to drop it when the Widget is destroyed. This is a precausion to avoid race conditions if another widget pushes a new scope while this one isn't destroyed yet. See https://github.com/fluttercommunity/get_it/issues/316

• I forgot to add the new allReadyHandler to the GetItStateMixin too

• added allReadyHandler. Although allReady already has an optional handler, it will always trigger a rebuild which leads to a double execution of the registered handler. This might not always be what you want.

  /// registers a handler that is called when the all-ready state is reached
  /// it does not trigger a rebuild like [allReady] does
  /// you can force a timeout Exceptions if [allReady] completed
  /// within [timeout] which will call [onError]
  void allReadyHandler(void Function(BuildContext context)? onReady,
          {void Function(BuildContext context, Object? error)? onError,
          Duration? timeout})

Although the change in the API is a minor one and most of you won't see a difference it is a change in the function signature of watchOnly that justifies a major version bump.

• watchOnly got more powerful and flexible. You know can trigger a rebuild on every change notification of the Listenable for instance a simple ChangeNotifier. Also you can pass in a direct target if the listenable that you want to observe is available outside GetIt.

  /// like watch but for simple `Listenable` objects.
  /// It only triggers a rebuild when the value that
  /// [only] returns changes. With that you can react to changes of single members
  /// of [T]
  /// If [only] is null it will trigger a rebuild every time the `Listenable` changes
  /// in this case R has to be equal to T
  /// If [target] is not null whatch will observe this Object as Listenable instead of
  /// looking inside GetIt
  R watchOnly<T extends Listenable, R>(
    R Function(T)? only, {
    T? target,
    String? instanceName,
  }) =>

• fix for https://github.com/escamoteur/get_it_mixin/issues/16
• fix for https://github.com/escamoteur/get_it_mixin/issues/17
• fix for https://github.com/escamoteur/get_it_mixin/issues/20

• fix for https://github.com/escamoteur/get_it_mixin/issues/13

• fix for https://github.com/escamoteur/get_it_mixin/issues/8

• Removed possibly unnecessary reset of the watches on update of the widgets. If you experience any strange behaviour with this version, please let me know

• Added new function to rebuild a widget as soon as a GetIt-Scope changed

Trigger a rebuild on GetIt Scope changes #

As it is possible that objects registered in a higher GetIt-Scope can shadow objects of the same registration type in a lower scope it is important to ensure that the UI can update its references to the newly active object (the one last registered). The get_it_mixin detects such changes and updates them on the next rebuild but if you want to ensure that this happens immediately you can put a call to

  /// Will triger a rebuild of the Widget if any new GetIt-Scope is pushed or popped
  /// This function will return `true` if the change was a push otherwise `false`
  /// If no change has happend the return value will be null
  bool? rebuildOnScopeChanges();

• Major version bump because get_it V7.0.0 is a breaking change

• Switched internal structure from LinkedList to List because of https://github.com/dart-lang/sdk/issues/45767 which made the package unusable on web

• Added option to watch any ValueListenable with watch(target:)

• Null safety migration

• fixed bug that you couldn't use watchOnly and watchXonly more than once on the same Listenable object.
• split source into several part files.

• Refactoring and corrected cancelation of futures

• Bug fix for Hot reload and added a warning in the readme

• the previous implementation of allReady() would have called GetIt.allReady on every build which would return every time a new Future so that it did rebuild unpredictable

• deprecated registerValueListenableHandler in favour of registerHandler

• some breaking changes of the handler function definitions
• added support for allReady and isReady

• now with readme and tests

• Initial release without docs and tests