NavigatorCubit class Null safety

A Cubit whose state is a List of Pages.

This is an abstract class so cannot be instantiated directly. Instead, create your own class which extends NavigatorCubit:

class HomeNavigatorCubit extends NavigatorCubit {
  HomeNavigatorCubit({required Page root}) : super(root: root);
}
Inheritance

Constructors

Constructs a NavigatorCubit with the given root page.

Properties

hashCode int
The hash code for this object.
read-onlyinherited
isClosed bool
Whether the bloc is closed.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
state List<Page>
The current state.
read-onlyinherited
stream Stream<List<Page>>
The current state stream.
read-onlyinherited

Methods

addError(Object error, [StackTrace? stackTrace]) → void
Reports an error which triggers onError with an optional StackTrace.
@mustCallSuperinherited
close() Future<void>
Closes the instance. This method should be called when the instance is no longer needed. Once close is called, the instance can no longer be used.
@mustCallSuperinherited
emit(List<Page> state) → void
Updates the state to the provided state. emit does nothing if the instance has been closed or if the state being emitted is equal to the current state.
inherited
listen(void onData(List<Page>)?, {Function? onError, void onDone()?, bool? cancelOnError}) StreamSubscription<List<Page>>
Adds a subscription to the Stream<State>. Returns a StreamSubscription which handles events from the Stream<State> using the provided onData, onError and onDone handlers.
@Deprecated('Use stream.listen instead. Will be removed in v8.0.0')inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
onChange(Change<List<Page>> change) → void
Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the cubit is updated. onChange is a great spot to add logging/analytics for a specific cubit.
override
onError(Object error, StackTrace stackTrace) → void
Called whenever an error occurs and notifies BlocObserver.onError.
pop() bool
Removes the top-most Page from the stack i.e. navigate back one page.
push(Page page) → void
Pushes the given page to the top of the stack.
replace(Page page) → void
Replaces the top-most Page in the stack with the given page.
toString() String
A string representation of this object.
inherited

Operators

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