Open
Conversation
Contributor
Author
|
relates to #1570 |
|
View your CI Pipeline Execution ↗ for commit 9af508c
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview3 package(s) bumped directly, 10 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
📝 WalkthroughWalkthroughThis PR adds reset listener support: introduces Changes
Sequence Diagram(s)mermaid Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2102 +/- ##
==========================================
- Coverage 90.35% 90.27% -0.08%
==========================================
Files 38 49 +11
Lines 1752 2047 +295
Branches 444 532 +88
==========================================
+ Hits 1583 1848 +265
- Misses 149 179 +30
Partials 20 20 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
harry-whorlow
force-pushed
the
reset-listeners
branch
2 times, most recently
from
d028b99 to
59c6210
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
.changeset/reset-listeners.md (1)
5-5: Consider clarifying reset propagation semantics in the release note.A short note that
form.reset()does not invoke field-levelonReset(onlyfield.reset()does) would set clearer expectations for users upgrading.📝 Suggested wording
-Add `onReset` listener support for forms and fields, add `reset` method to `FieldApi`, and expand `ListenerCause` type with `'reset'` and `'unmount'` values +Add `onReset` listener support for forms and fields, add `reset` method to `FieldApi`, and expand `ListenerCause` type with `'reset'` and `'unmount'` values. Note: field-level `onReset` is triggered by `field.reset()`; `form.reset()` triggers only the form-level `onReset`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.changeset/reset-listeners.md at line 5, The release note is unclear about reset propagation: explicitly state that calling form.reset() will not trigger field-level onReset listeners and that only calling field.reset() invokes those field-level onReset handlers; mention the added FieldApi.reset method and the new ListenerCause union values ('reset' and 'unmount') so readers know to update expectations and listener handling when upgrading.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/framework/react/guides/listeners.md`:
- Line 23: The docs add global `onReset` but the "Form listeners" section omits
it; update the Form listeners subsection to document `onReset` alongside
`onMount`/`onSubmit` and the propagated `onChange`/`onBlur`. Describe when
`onReset` fires (form reset events), its signature/params, whether it is
propagated to fields, and give a short usage example/notes consistent with
`onSubmit`/`onMount` entries so the global event list and form-level
documentation match.
In `@packages/form-core/src/FieldApi.ts`:
- Around line 11-14: Remove the unused imports getBy and setBy from the import
list in FieldApi.ts: locate the import that currently lists getBy,
getSyncValidatorArray, mergeOpts, setBy and delete getBy and setBy so only used
utilities (e.g., getSyncValidatorArray, mergeOpts) remain; ensure no other
references to getBy or setBy exist in the file before committing.
---
Nitpick comments:
In @.changeset/reset-listeners.md:
- Line 5: The release note is unclear about reset propagation: explicitly state
that calling form.reset() will not trigger field-level onReset listeners and
that only calling field.reset() invokes those field-level onReset handlers;
mention the added FieldApi.reset method and the new ListenerCause union values
('reset' and 'unmount') so readers know to update expectations and listener
handling when upgrading.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6f949218-a373-4a2f-aab6-b1e7a6e0c763
📒 Files selected for processing (9)
.changeset/reset-listeners.mddocs/framework/angular/guides/listeners.mddocs/framework/react/guides/listeners.mddocs/framework/vue/guides/listeners.mdpackages/form-core/src/FieldApi.tspackages/form-core/src/FormApi.tspackages/form-core/src/types.tspackages/form-core/tests/FieldApi.spec.tspackages/form-core/tests/FormApi.spec.ts
harry-whorlow
force-pushed
the
reset-listeners
branch
from
3b60484 to
7108924
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/framework/react/guides/listeners.md`:
- Line 16: The header text "Field level events that can be "listened" to are:"
should use standard phrasing and a hyphenated adjective; update the phrase to
"Field-level events that can be listened to are:" by hyphenating "Field-level"
and removing the quotes around listened so the sentence reads naturally; locate
the string "Field level events that can be "listened" to are:" in the
listeners.md content and replace it accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a4fed69e-5a25-429f-a760-b27dc28c1881
📒 Files selected for processing (3)
.changeset/reset-listeners.mddocs/framework/react/guides/listeners.mdpackages/form-core/src/FieldApi.ts
✅ Files skipped from review due to trivial changes (1)
- .changeset/reset-listeners.md
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/form-core/src/FieldApi.ts
harry-whorlow
force-pushed
the
reset-listeners
branch
from
4b32346 to
845d37f
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/framework/react/guides/listeners.md (1)
16-16:⚠️ Potential issue | 🟡 MinorFix phrasing on Line 16 for clarity and style consistency.
Line 16 still reads awkwardly (
Field leveland quoted"listened"). Use the standard phrasing below.✏️ Suggested docs patch
-Field level events that can be "listened" to are: +Field-level events that can be listened to are:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/framework/react/guides/listeners.md` at line 16, Replace the awkward phrasing `Field level events that can be "listened" to are:` with a clearer, styled sentence such as `Field-level events that can be listened to include:`; remove the unnecessary quotes around listened, add the hyphen in Field-level, and end with a colon or "include:" for better flow in the document (edit the line containing that exact text).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/framework/react/guides/listeners.md`:
- Line 16: Replace the awkward phrasing `Field level events that can be
"listened" to are:` with a clearer, styled sentence such as `Field-level events
that can be listened to include:`; remove the unnecessary quotes around
listened, add the hyphen in Field-level, and end with a colon or "include:" for
better flow in the document (edit the line containing that exact text).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5cf35176-dc17-469a-b338-2d2320ed2758
📒 Files selected for processing (9)
.changeset/reset-listeners.mddocs/framework/angular/guides/listeners.mddocs/framework/react/guides/listeners.mddocs/framework/vue/guides/listeners.mdpackages/form-core/src/FieldApi.tspackages/form-core/src/FormApi.tspackages/form-core/src/types.tspackages/form-core/tests/FieldApi.spec.tspackages/form-core/tests/FormApi.spec.ts
✅ Files skipped from review due to trivial changes (4)
- docs/framework/angular/guides/listeners.md
- docs/framework/vue/guides/listeners.md
- packages/form-core/src/types.ts
- .changeset/reset-listeners.md
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/form-core/tests/FormApi.spec.ts
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
adds form listeners for the reset event
Summary by CodeRabbit
New Features
Documentation
Tests