StateNotifierProvider<Notifier extends StateNotifier<State>, State> 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<TodosNotifier, List<Todo>>((ref) => TodosNotifier());

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

Widget build(BuildContext context, WidgetRef ref) {
  // rebuild the widget when the todo list changes
  List<Todo> todos =;

  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),
Mixed in types
  • @sealed


StateNotifierProvider(Create<Notifier, StateNotifierProviderRef<Notifier, State>> create, {String? name, List<ProviderOrFamily>? dependencies, Family<dynamic, dynamic, ProviderBase>? from, Object? argument})
Creates a StateNotifier and expose its current state.


allTransitiveDependencies List<ProviderOrFamily>?
All the dependencies of a provider and their dependencies too.
argument Object?
If this provider was created with the .family modifier, argument is variable used.
dependencies List<ProviderOrFamily>?
The list of providers that this provider potentially depends on.
from Family<dynamic, dynamic, ProviderBase>?
If this provider was created with the .family modifier, from is the .family instance.
hashCode int
The hash code for this object.
no setterinherited
name String?
A custom label for providers.
notifier AlwaysAliveProviderBase<Notifier>
Obtains the StateNotifier associated with this AutoDisposeStateNotifierProvider, without listening to it.
originProvider ProviderBase<Notifier>
The provider that will be refreshed when calling ProviderContainer.refresh and that will be overridden when passed to ProviderScope.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


create(covariant ProviderElementBase<State> ref) → State
Initializes the state of a provider
createElement() ProviderElementBase<State>
An internal method that defines how a provider behaves.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
overrideWithProvider(StateNotifierProvider<Notifier, State> value) Override
Overrides a provider with a value, ejecting the default behaviour.
overrideWithValue(Notifier value) Override
Overrides a provider with a value, ejecting the default behaviour.
select<Selected>(Selected selector(State value)) AlwaysAliveProviderListenable<Selected>
Partially listen to a provider.
toString() String
A string representation of this object.
updateShouldNotify(State previousState, State newState) bool
Called when a provider is rebuilt. Used for providers to not notify their listeners if the exposed value did not change.


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


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