-
Notifications
You must be signed in to change notification settings - Fork 44
docs(devtools): add section for withTrackedReducer
#276
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.
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
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,12 @@ title: withDevtools() | |
| import { withDevtools } from '@angular-architects/ngrx-toolkit'; | ||
| ``` | ||
|
|
||
| <!-- TODO - add backported version --> | ||
|
|
||
| :::info | ||
| Devtools integration with `@ngrx/signals/events` is now available starting in version 20.TODO | ||
| ::: | ||
|
|
||
| Redux Devtools is a powerful browser extension tool, that allows you to inspect every change in your stores. Originally, it was designed for Redux, but it can also be used with the SignalStore. You can download it for Chrome [here](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd). | ||
|
|
||
| To use the Devtools, you need to add the `withDevtools()` extension to your SignalStore: | ||
|
|
@@ -165,6 +171,24 @@ const Store = signalStore( | |
| ); | ||
| ``` | ||
|
|
||
| ## Events tracking: `withTrackedReducer` | ||
|
|
||
| `withTrackedReducer` tracks state changes within the events | ||
| plugin. This utility automatically derives the event name, streamlining | ||
| the tracking process. | ||
|
|
||
| To use it | ||
|
|
||
| 1. _Replace usages of `withReducer` with `withTrackedReducer`_. Note: native `withReducer` support is planned for the future, but that requires upstream support from `@ngrx/signals`. | ||
| 2. _[`withGlitchTracking`](#withglitchtracking) must be specified within `withDevtools`_. If `withTrackedReducer` is used without the devtools and glitch tracking, runtime errors will be thrown. | ||
|
|
||
| ```ts | ||
| // Must have all three, or runtime errors for thee! | ||
| import { withTrackedReducer, withGlitchTracking, withDevtools } from '@angular-architects/ngrx-toolkit'; | ||
|
|
||
| const Store = signalStore({ providedIn: 'root' }, withDevtools('store', withGlitchTracking()), withTrackedReducer()); | ||
|
||
| ``` | ||
|
|
||
| ## Disabling Devtools in production | ||
|
|
||
| `withDevtools()` is by default enabled in production mode, if you want to tree-shake it from the application bundle you need to abstract it in your environment file. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would be v21.0 and v20.6.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But we are backporting this to v20 right? 05a5ad5
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, yes and it should be 20.7 (20.6 is already out)...sorry