Skip to content

feat(replay_bloc): add support for undo/redo multiple steps #4438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat(replay_bloc): add support for undo/redo multiple steps #4438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8150d7f
feat(replay_bloc): add suppport for undo/redo multiple steps
ricardodalarme May 1, 2025
537d8f5
Merge branch 'master' into feat/undo-multile-steps
felangel Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 46 additions & 10 deletions packages/replay_bloc/lib/src/change_stack.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,55 @@ class _ChangeStack<T> {
_redos.clear();
}

void redo() {
if (canRedo) {
final change = _redos.removeFirst();
_history.addLast(change);
return _shouldReplay(change._newValue) ? change.execute() : redo();
void redo(int steps) {
if (steps <= 0) return;

var effectiveSteps = steps;
while (effectiveSteps > 0 && canRedo) {
_Change<T>? changeToExecute;
while (_redos.isNotEmpty) {
final change = _redos.first;
if (_shouldReplay(change._newValue)) {
changeToExecute = _redos.removeFirst();
break;
} else {
_history.addLast(_redos.removeFirst());
}
}

if (changeToExecute != null) {
_history.addLast(changeToExecute);
changeToExecute.execute();
effectiveSteps--;
} else {
break;
}
}
}

void undo() {
if (canUndo) {
final change = _history.removeLast();
_redos.addFirst(change);
return _shouldReplay(change._oldValue) ? change.undo() : undo();
void undo(int steps) {
if (steps <= 0) return;

var effectiveSteps = steps;
while (effectiveSteps > 0 && canUndo) {
_Change<T>? changeToUndo;
while (_history.isNotEmpty) {
final change = _history.last;
if (_shouldReplay(change._oldValue)) {
changeToUndo = _history.removeLast();
break;
} else {
_redos.addFirst(_history.removeLast());
}
}

if (changeToUndo != null) {
_redos.addFirst(changeToUndo);
changeToUndo.undo();
effectiveSteps--;
} else {
break;
}
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/replay_bloc/lib/src/replay_bloc.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,10 @@ mixin ReplayBlocMixin<Event extends ReplayEvent, State> on Bloc<Event, State> {
}

/// Undo the last change.
void undo() => _changeStack.undo();
void undo([int steps = 1]) => _changeStack.undo(steps);

/// Redo the previous change.
void redo() => _changeStack.redo();
void redo([int steps = 1]) => _changeStack.redo(steps);

/// Checks whether the undo/redo stack is empty.
bool get canUndo => _changeStack.canUndo;
Expand Down
4 changes: 2 additions & 2 deletions packages/replay_bloc/lib/src/replay_cubit.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ mixin ReplayCubitMixin<State> on Cubit<State> {
}

/// Undo the last change.
void undo() => _changeStack.undo();
void undo([int steps = 1]) => _changeStack.undo(steps);

/// Redo the previous change.
void redo() => _changeStack.redo();
void redo([int steps = 1]) => _changeStack.redo(steps);

/// Checks whether the undo/redo stack is empty.
bool get canUndo => _changeStack.canUndo;
Expand Down
Loading