ReplayCubitMixin<State> mixin

A mixin which enables undo and redo operations for Cubit classes.

Superclass Constraints

Mixin Applications

Properties

canRedo → bool: Checks whether the undo/redo stack is at the current change.
no setter
canUndo → bool: Checks whether the undo/redo stack is empty.
no setter
hashCode → int: The hash code for this object.
no setterinherited
isClosed → bool: Whether the bloc is closed.
no setterinherited
limit ← int: Sets the internal undo/redo size limit. By default there is no limit.
no getter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state → State: The current state.
no setterinherited
stream → Stream<State>: The current stream of states.
no setterinherited

addError(Object error, [StackTrace? stackTrace]) → void: Reports an error which triggers onError with an optional StackTrace.
inherited
clearHistory() → void: Clear undo/redo history.
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(State state) → void: Updates the state to the provided state. emit does nothing if the state being emitted is equal to the current state.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onChange(Change<State> 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.
inherited
onError(Object error, StackTrace stackTrace) → void: Called whenever an error occurs and notifies BlocObserver.onError.
inherited
redo() → void: Redo the previous change.
shouldReplay(State state) → bool: Checks whether the given state should be replayed from the undo/redo stack.
toString() → String: A string representation of this object.
inherited
undo() → void: Undo the last change.