StateNotifierProvider<T extends StateNotifier<Object>> class

Creates a StateNotifier and expose its current state.

This provider is used in combination with package:state_notifier.

Combined with StateNotifier, StateNotifierProvider can be used to manipulate advanced states, that would otherwise be difficult to represent with simpler providers such as Provider or FutureProvider.

For example, you may have a todo-list, where you can add and remove and complete a todo. Using StateNotifier, you could represent such state as:

class TodosNotifier extends StateNotifier<List<Todo>> {
  TodosNotifier(): super([]);

  void add(Todo todo) {
    state = [...state, todo];

  void remove(String todoId) {
    state = [
      for (final todo in state)
        if ( != todoId) todo,

  void toggle(String todoId) {
    state = [
      for (final todo in state)
        if ( == todoId) todo.copyWith(completed: !todo.completed),

Which you can then pass to a StateNotifierProvider like so:

final todosProvider = StateNotifierProvider((ref) => TodosNotifier());

And finally, you can interact with it inside your UI:

Widget build(BuildContext context, ScopedReader watch) {
  // rebuild the widget when the todo list changes
  List<Todo> todos = watch(todosProvider.state);

  return ListView(
    children: [
      for (final todo in todos)
           value: todo.completed,
           // When tapping on the todo, change its completed status
           onChanged: (value) =>,
           title: Text(todo.description),
Available Extensions


StateNotifierProvider(Create<T, ProviderReference> create, {String name})
Creates a StateNotifier and expose its current state. [...]


argument Object
If this provider was created with the .family modifier, argument is variable used.
read-only, inherited
from Family<dynamic, dynamic, dynamic, ProviderReference, RootProvider>
If this provider was created with the .family modifier, from is the .family instance.
read-only, inherited
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
name String
{@template} A custom label for providers. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited


createElement() → ProviderElement<T, T>
An internal method that defines how a provider behaves.
createState() → _ProviderState<T>
An internal method that creates the state of a provider.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
overrideWithProvider(RootProvider<Object, T> provider) → ProviderOverride
Overrides the behavior of this provider with another provider. [...]
overrideWithValue(T value) Override
Overrides the behavior of a provider with a value. [...]
select<Selected>(Selected selector(T value)) ProviderListenable<Selected>
Partially listen to a provider. [...]
toString() String
Returns a string representation of this object.


operator ==(Object other) bool
The equality operator. [...]


autoDispose → const AutoDisposeStateNotifierProviderBuilder
Marks the provider as automatically disposed when no-longer listened. [...]
const AutoDisposeStateNotifierProviderBuilder()
family → const StateNotifierProviderFamilyBuilder
A group of providers that builds their value from an external parameter. [...]
const StateNotifierProviderFamilyBuilder()