collection_notifiers 1.1.0 copy "collection_notifiers: ^1.1.0" to clipboard
collection_notifiers: ^1.1.0 copied to clipboard

Collections with implementation of ChangeNotifier/ValueListenable for minimum rebuild and better syntax

collection_notifiers #

Build Status Build Status codecov Star on Github License: MIT

Wrapped collections with ChangeNotifier & ValueListenable interface for optimized rebuilds and better syntax.

Features #

Riverpod/Provider without collection_notifiers #

  • Always triggers setState
  • Always creates copies
  • Verbose syntax
final setProvider = StateProvider((ref) => <E>{});
onAdd: (value) => ref.read(setProvider.state).update((state) {
  return <E>{...state, value}; // a new copy created
});
onRemove: (value) => ref.read(setProvider.state).update((state) {
  return <E>{...state..remove(value)}; // a new copy created
});

Riverpod/Provider with collection_notifiers #

  • Triggers setState only when needed
  • Creates zero copy
  • Terse syntax
final setProvider = ChangeNotifierProvider((ref) => SetNotifier<E>());
onAdd: ref.read(setProvider).add; // does not create copy
onRemove: ref.read(setProvider).remove; // does not create copy

Operators are also overridden, List:

final listProvider = ChangeNotifierProvider((ref) => ListNotifier([0]));
ref.read(listProvider)[0] = 1; // will trigger setState
ref.read(listProvider)[0] = 1; // won't trigger setState

Similarly, the Map:

final mapProvider = ChangeNotifierProvider((ref) => MapNotifier());
ref.read(mapProvider)['a'] = 1; // will trigger setState
ref.read(mapProvider)['a'] = 1; // won't trigger setState

Implementations #

Collection Status Notifier
Set Completed SetNotifier
List Completed(see notes) ListNotifier
Map Completed MapNotifier
Queue Completed QueueNotifier

Open an issue if there is any specific collection/method you need.

Element Equality #

Element equation(== operator) must be handled by you beforehand. For that case, code generation(freezed, built_value etc.) or equatable are highly recommended.

Notes #

  • collection_notifiers do not handle any Exception because it may cause confusing development experience and sneaky bugs.

  • Methods with overridden logic, always mimics default implementation. Hence, no additional Exception is also produced.

  • Methods that requires collection equalities(like sort(), shuffle() etc...) always trigger setState.

6
likes
160
pub points
57%
popularity

Publisher

unverified uploader

Collections with implementation of ChangeNotifier/ValueListenable for minimum rebuild and better syntax

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

collection, flutter

More

Packages that depend on collection_notifiers