collection_notifiers 1.0.4 icon indicating copy to clipboard operation
collection_notifiers: ^1.0.4 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 #

  • Best possible syntax, minimum amount of code

  • Huge performance benefits for medium/large collections

  • Fully compatible with ValueListenableBuilder and Riverpod / Provider

  • Dead simple to use

  • Lightweight

Riverpod/Provider without collection_notifiers #

  • Always triggers setState
  • Always creates copies
  • Verbose syntax
final setProvider = StateProvider((ref) => <E>{});
onAdd: (value) => {
  return <E>{...state, value}; // a new copy created
onRemove: (value) => {
  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:; // does not create copy
onRemove:; // does not create copy

Operators are also overridden, List:

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

Similarly, the Map:

final mapProvider = ChangeNotifierProvider((ref) => MapNotifier({'a' : 1}));['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 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.

pub points


unverified uploader

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

Repository (GitHub)


API reference


Icon for licenses.MIT (LICENSE)


collection, flutter


Packages that depend on collection_notifiers