Skip to content

docs(preact): add missing onUnmount to listeners event list#2183

Open
dojhoanrd-jw wants to merge 1 commit into
TanStack:mainfrom
dojhoanrd-jw:docs/preact-listeners-add-onunmount
Open

docs(preact): add missing onUnmount to listeners event list#2183
dojhoanrd-jw wants to merge 1 commit into
TanStack:mainfrom
dojhoanrd-jw:docs/preact-listeners-add-onunmount

Conversation

@dojhoanrd-jw
Copy link
Copy Markdown
Contributor

@dojhoanrd-jw dojhoanrd-jw commented May 15, 2026

🎯 Changes

Add missing event to the Preact listeners guide:

  • Preact listeners guide (docs/framework/preact/guides/listeners.md): Add onUnmount to the list of events that can be "listened" to. The onUnmount field listener is defined in packages/form-core/src/FieldApi.ts alongside onChange, onBlur, onMount, and onSubmit, and is already documented in the Angular listeners guide. This update makes the Preact guide consistent with Angular and accurately reflects the events available in the API.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated Preact form listeners documentation to include onUnmount as an available event option.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ab2a280f-c327-47e9-b33f-34e5d2bff879

📥 Commits

Reviewing files that changed from the base of the PR and between 3886dcc and 2233f2d.

📒 Files selected for processing (1)
  • docs/framework/preact/guides/listeners.md

📝 Walkthrough

Walkthrough

Documentation for Preact form listeners is updated to include onUnmount as a supported event. The change adds a single item to the listener event list within the existing guide.

Changes

Preact Listener Events Documentation

Layer / File(s) Summary
Add onUnmount to listener events list
docs/framework/preact/guides/listeners.md
The listener event list is updated to include onUnmount as a supported event that form listeners can observe.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 The listener guide grows bright and true,
With onUnmount events fresh and new,
Documentation blooms with grace,
One line added to its rightful place! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding the missing onUnmount event to the Preact listeners documentation.
Description check ✅ Passed The description is well-structured, follows the template, and includes all required sections with complete information about the change and its rationale.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant