NavigatorCubit class abstract
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);
}
Constructors
-
Constructs a NavigatorCubit with the given
root
page.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isClosed → bool
-
Whether the bloc is closed.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
→ List<
Page> -
The current state.
no setterinherited
-
stream
→ Stream<
List< Page> > -
The current state stream.
no setterinherited
Methods
-
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggers onError with an optional StackTrace.inherited -
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.
inherited
-
emit(
List< Page> state) → void -
Updates the
state
to the providedstate
. emit does nothing if the instance has been closed or if thestate
being emitted is equal to the currentstate
.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 theStream<State>
using the providedonData
,onError
andonDone
handlers.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onChange(
Change< List< change) → voidPage> > -
Called whenever a
change
occurs with the givenchange
. Achange
occurs when a newstate
is emitted. onChange is called before thestate
of thecubit
is updated. onChange is a great spot to add logging/analytics for a specificcubit
. -
onError(
Object error, StackTrace stackTrace) → void -
Called whenever an
error
occurs and notifiesBlocObserver.onError
.inherited -
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