Skip to content

docs: mention clearUndoRedo soft/hard reset #278

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

Merged
rainerhahnekamp merged 1 commit into from
Jan 19, 2026
Merged

docs: mention clearUndoRedo soft/hard reset #278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion docs/docs/with-undo-redo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Example:

```typescript
import { withUndoRedo } from '@angular-architects/ngrx-toolkit';
import { clearUndoRedo } from '@angular-architects/ngrx-toolkit';

const SyncStore = signalStore(
withUndoRedo({
Expand All @@ -32,7 +33,6 @@ public class UndoRedoComponent {

canUndo = this.store.canUndo; // use in template or in ts
canRedo = this.store.canRedo; // use in template or in ts
clearStack = this.store.clearStack; // use in template or in ts

undo(): void {
if (!this.canUndo()) return;
Expand All @@ -45,7 +45,11 @@ public class UndoRedoComponent {
}

clearStack(): void {
// Does a soft reset (not setting the state to `null`) by default.
clearUndoRedo(this.store);

// The hard reset can be set via options,
// clearUndoRedo(store, { lastRecord: null })
}
}
```