OrderedMapNotifier<K, V> class

A reactive ordered map notifier that extends ImmutableOrderedMap with change notification capabilities.

This class combines the immutability guarantees of ImmutableOrderedMap with Flutter's ChangeNotifier pattern, making it ideal for reactive UI programming. Any mutations to the map automatically trigger notifyListeners(), allowing widgets to rebuild when the underlying data changes.

class MyWidget extends StatefulWidget {
  @override
  State<MyWidget> createState() => _MyWidgetState();
}

class _MyWidgetState extends State<MyWidget> {
  late final OrderedMapNotifier<String, User> mapNotifier;

  @override
  void initState() {
    super.initState();
    mapNotifier = OrderedMapNotifier<String, User>(toKey: (user) => user.id);
    mapNotifier.addListener(() => setState(() {}));

    // Add some initial data
    mapNotifier.assignAllOrdered([
      User(id: 'user1', name: 'Alice'),
      User(id: 'user2', name: 'Bob'),
    ]);
  }

  @override
  Widget build(BuildContext context) {
    return ListView.builder(
      itemCount: mapNotifier.length,
      itemBuilder: (context, index) {
        final user = mapNotifier.orderedValues[index];
        return ListTile(
          title: Text(user.name),
          subtitle: Text(user.id),
        );
      },
    );
  }

  @override
  void dispose() {
    mapNotifier.dispose();
    super.dispose();
  }
}

@ai Use this class in Flutter applications where you need reactive map updates. Remember to call dispose() when the notifier is no longer needed to prevent memory leaks. The toKey function is required for automatic key generation from values.

Inheritance

Object
ImmutableOrderedMap<K, V>
OrderedMapNotifier

Mixed-in types

ChangeNotifier

Available extensions

Constructors

OrderedMapNotifier({OrderedMapToKeyFunction<K, V>? toKey}): Creates a reactive ordered map notifier with the specified key extraction function.

Properties

first → K: The first element.
no setterinherited
firstOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The first element of this iterator, or null if the iterable is empty.
no setter
hashCode → int: The hash code for this object.
no setterinherited
hasListeners → bool: Whether any listeners are currently registered.
no setterinherited
indexed → Iterable<(int, T)>: Available on Iterable<T>, provided by the IterableExtensions extension
Pairs of elements of the indices and elements of this iterable.
no setter
isEmpty → bool: Whether this collection has no elements.
no setterinherited
isNotEmpty → bool: Whether this collection has at least one element.
no setterinherited
iterator → Iterator<K>: A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
keys → List<K>: Returns an unmodifiable list of all keys in insertion order.
no setterinherited
last → K: The last element.
no setterinherited
lastOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The last element of this iterable, or null if the iterable is empty.
no setter
length → int: The number of elements in this Iterable.
no setterinherited
nonNulls → Iterable<T>: Available on Iterable<T?>, provided by the NullableIterableExtensions extension
The non-null elements of this iterable.
no setter
orderedValues → List<V>: Returns an unmodifiable list of all values in insertion order.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
single → K: Checks that this iterable has only one element, and returns that element.
no setterinherited
singleOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The single element of this iterator, or null.
no setter
toJSIterable → JSIterable<T>: Available on Iterable<T>, provided by the IterableToJSIterable extension
A JSIterable wrapper that proxies to the Dart iterable API.
no setter
toKey → OrderedMapToKeyFunction<K, V>?: A function that converts values to their corresponding keys.
finalinherited
wait → Future<List<T>>: Available on Iterable<Future<T>>, provided by the FutureIterable extension
Waits for futures in parallel.
no setter

Methods

addListener(VoidCallback listener) → void: Register a closure to be called when the object changes.
inherited
any(bool test(K element)) → bool: Checks whether any element of this iterable satisfies test.
inherited
asNameMap() → Map<String, T>: Available on Iterable<T>, provided by the EnumByName extension
Creates a map from the names of enum values to the values.
assignAll(Map<K, V> map) → void: Replaces all items in this collection with the provided map.
inherited
assignAllOrdered(Iterable<V> items) → void: Replaces all items in this collection with values from the provided items list.
override
byName(String name) → T: Available on Iterable<T>, provided by the EnumByName extension
Finds the enum value in this list with name name.
cast<R>() → Iterable<R>: A view of this iterable as an iterable of R instances.
inherited
clear() → void: Removes all mappings from this map and notifies listeners.
override
contains(Object? element) → bool: Whether the collection contains an element equal to element.
inherited
containsKey(K key) → bool: Whether this map contains the specified key.
inherited
dispose() → void: Discards any resources used by the object.
inherited
elementAt(int index) → K: Returns the indexth element.
inherited
elementAtOrNull(int index) → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The element at position index of this iterable, or null.
every(bool test(K element)) → bool: Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(K element)) → Iterable<T>: Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(K element), {K orElse()?}) → K: The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, K element)) → T: Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<K> other) → Iterable<K>: Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(K element)) → void: Invokes action on each element of this iterable in iteration order.
inherited
join([String separator = ""]) → String: Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(K element), {K orElse()?}) → K: The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(K e)) → Iterable<T>: The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void: Call all the registered listeners.
inherited
reduce(K combine(K value, K element)) → K: Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(K key) → void: Removes the mapping for the specified key if it exists and notifies listeners.
override
removeListener(VoidCallback listener) → void: Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
singleWhere(bool test(K element), {K orElse()?}) → K: The single element that satisfies test.
inherited
skip(int count) → Iterable<K>: Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(K element)) → Iterable<K>: Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) → Iterable<K>: Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(K element)) → Iterable<K>: Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<K>: Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<K>: Creates a Set containing the same elements as this iterable.
inherited
toString() → String: Returns a string representation of (some of) the elements of this.
inherited
update(K key, V update(V), {V ifAbsent()?}) → V: Updates the value associated with the specified key using the provided update function.
inherited
upsert(V value, {bool putFirst = false, K? key}) → void: Inserts or updates the mapping for the specified key and value and notifies listeners.
override
upsertAll(Iterable<V> values, {bool putFirst = false, K? toKey(V)?}) → void: Inserts or updates multiple mappings from the provided values iterable and notifies listeners once.
override
where(bool test(K element)) → Iterable<K>: Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<R>: Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited
operator [](K key) → V?: Retrieves the value associated with the specified key.
inherited
operator []=(K key, V value) → void: Inserts or updates the mapping for the specified key and value.
inherited

OrderedMapNotifier<K, V> class

Constructors

Properties

Methods

Operators

xsoulspace_state_utils library