OrderedListNotifier<V> class

A reactive ordered list notifier that extends ImmutableOrderedList with change notification capabilities.

This class combines the immutability guarantees of ImmutableOrderedList with Flutter's ChangeNotifier pattern, making it ideal for reactive UI programming. Any mutations to the list 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> {
  final listNotifier = OrderedListNotifier<String>();

  @override
  void initState() {
    super.initState();
    listNotifier.addListener(() => setState(() {}));
  }

  @override
  Widget build(BuildContext context) {
    return ListView.builder(
      itemCount: listNotifier.length,
      itemBuilder: (context, index) => Text(listNotifier.elementAt(index)),
    );
  }

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

@ai Use this class in Flutter applications where you need reactive list updates. Remember to call dispose() when the notifier is no longer needed to prevent memory leaks.

Inheritance
Mixed-in types
Available extensions

Constructors

OrderedListNotifier()
A reactive ordered list notifier that extends ImmutableOrderedList with change notification capabilities.

Properties

first → V
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<V>
A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
last → V
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → V
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
wait → Future<List<T>>

Available on Iterable<Future<T>>, provided by the FutureIterable extension

Waits for futures in parallel.
no setter

Methods

add(V value) → void
Adds the specified value to the end of this ordered list and notifies listeners.
override
addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
addUnique(V value) → bool
Adds the specified value to the end of this ordered list if it doesn't already exist, and notifies listeners if the value was added.
override
any(bool test(V value)) → 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(List<V> items) → void
Replaces all items in this collection with the provided items.
inherited
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 items from this ordered list and notifies listeners.
override
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
dispose() → void
Discards any resources used by the object.
inherited
elementAt(int index) → V
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(V value)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(V element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(V value), {V orElse()?}) → V
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, V element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<V> other) → Iterable<V>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(V value)) → 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(V value), {V orElse()?}) → V
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(V 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(V combine(V value, V element)) → V
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(V value) → void
Removes the first occurrence of the specified value from this ordered list and notifies listeners.
override
removeAll(V value) → void
Removes all occurrences of the specified value from this ordered list.
inherited
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(V value), {V orElse()?}) → V
The single element that satisfies test.
inherited
skip(int count) → Iterable<V>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(V value)) → Iterable<V>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) → Iterable<V>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(V value)) → Iterable<V>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<V>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<V>
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
where(bool test(V value)) → Iterable<V>
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 [](int index) → V
Retrieves the item at the specified index.
inherited
operator []=(int index, V value) → void
Sets the item at the specified index to the specified value.
inherited