Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/esenmx/collection_notifiers
Collections with implementation of ValueListenable/ChangeNotifier for minimum rebuild and simplest syntax
https://github.com/esenmx/collection_notifiers
collection dart data-structures flutter performance-optimization state-management
Last synced: about 2 months ago
JSON representation
Collections with implementation of ValueListenable/ChangeNotifier for minimum rebuild and simplest syntax
- Host: GitHub
- URL: https://github.com/esenmx/collection_notifiers
- Owner: esenmx
- License: mit
- Created: 2022-01-23T20:42:51.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-28T12:52:30.000Z (about 1 year ago)
- Last Synced: 2024-08-22T22:51:22.593Z (4 months ago)
- Topics: collection, dart, data-structures, flutter, performance-optimization, state-management
- Language: Dart
- Homepage:
- Size: 254 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# collection_notifiers
Wrapped [collections][collections] with [ChangeNotifier][ChangeNotifier] & [ValueListenable][ValueListenable]
interface for optimized rebuilds and better syntax.
## Features
- Huge performance benefits for medium/large collections
- Best possible syntax, minimum amount of code
- Fully compatible with [ValueListenableBuilder][ValueListenableBuilder] and [Riverpod][Riverpod] / [Provider][Provider]
- Dead simple to use
### Riverpod/Provider without `collection_notifiers`
- Always `triggers setState`
- Always `creates copies`
- `Verbose` syntax
```dart
final setProvider = StateProvider((ref) => {});
```
```dart
onAdd: (value) => ref.read(setProvider.state).update((state) {
return {...state, value}; // a new copy created
});
onRemove: (value) => ref.read(setProvider.state).update((state) {
return {...state..remove(value)}; // a new copy created
});
```
### Riverpod/Provider with `collection_notifiers`
- Triggers `setState only when needed`
- Creates `zero copy`
- `Terse` syntax
```dart
final setProvider = ChangeNotifierProvider((ref) => SetNotifier());
```
```dart
onAdd: ref.read(setProvider).add; // does not create copy
onRemove: ref.read(setProvider).remove; // does not create copy
```
Operators are also overridden, `List`:
```dart
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`:
```dart
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](https://api.dart.dev/stable/2.13.4/dart-core/Object/operator_equals.html)) must be
handled by you beforehand. For that case, code generation([freezed][freezed], [built_value][built_value] etc.) or
[equatable][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.
[//]: # (Links)
[collections]: https://api.dart.dev/stable/dart-collection/dart-collection-library.html
[ChangeNotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html
[ValueListenable]: https://api.flutter.dev/flutter/foundation/ValueListenable-class.html
[ValueListenableBuilder]: https://api.flutter.dev/flutter/widgets/ValueListenableBuilder-class.html
[Riverpod]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ChangeNotifierProvider-class.html
[Provider]: https://pub.dev/documentation/provider/latest/provider/ChangeNotifierProvider-class.html
[freezed]: https://pub.dev/packages/freezed
[built_value]: https://pub.dev/packages/built_value
[equatable]: https://pub.dev/packages/equatable