docs(vue): add Built-in Debouncing and Form listeners sections to listeners guide#2184
docs(vue): add Built-in Debouncing and Form listeners sections to listeners guide#2184dojhoanrd-jw wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughThe Vue listeners guide is enhanced with two new documentation sections: a "Built-in Debouncing" section explaining ChangesVue Listeners Guide Expansion
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/framework/vue/guides/listeners.md`:
- Line 68: Update the two section headings currently written as "### Built-in
Debouncing" (and the other heading flagged around the same spot) to use H2 level
(prefix with "##" instead of "###") so the document has proper heading
hierarchy; locate the headings by their literal text ("Built-in Debouncing" and
the other flagged heading text) and change their markdown prefixes 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: 9e2d2c6c-fac0-48b5-9855-8000e994d89d
📒 Files selected for processing (1)
docs/framework/vue/guides/listeners.md
| </template> | ||
| ``` | ||
|
|
||
| ### Built-in Debouncing |
There was a problem hiding this comment.
Fix heading levels to follow markdown hierarchy.
Both new section headings use h3 (###) but should use h2 (##) since there are no h2 headings in this document. This violates markdown heading hierarchy rules.
📝 Proposed fix
-### Built-in Debouncing
+## Built-in Debouncing-### Form listeners
+## Form listenersAlso applies to: 90-90
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 68-68: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/framework/vue/guides/listeners.md` at line 68, Update the two section
headings currently written as "### Built-in Debouncing" (and the other heading
flagged around the same spot) to use H2 level (prefix with "##" instead of
"###") so the document has proper heading hierarchy; locate the headings by
their literal text ("Built-in Debouncing" and the other flagged heading text)
and change their markdown prefixes accordingly.
🎯 Changes
Bring the Vue listeners guide to parity with the React listeners guide:
docs/framework/vue/guides/listeners.md): Add two missing sections that already exist in the React and Preact guides but were absent from the Vue guide:### Built-in Debouncing— documentsonChangeDebounceMs/onBlurDebounceMsfor field-level listeners.### Form listeners— documents form-level listeners (onMount,onSubmit,onChange,onBlur). The form-level listener API is defined inpackages/form-core/src/FormApi.tsand is re-exposed byuseForminpackages/vue-form/src/useForm.tsxviaFormOptions. Until now, Vue users had no documentation describing this capability (useful for autosave, mount-time logging, etc.).The new content is adapted from the React guide to use Vue-idiomatic syntax (
:listeners="{ ... }",<template v-slot="{ field }">,<script setup>). No existing content was modified — the change is purely additive (+61 lines), bringing the Vue guide to the same length and section structure as the React guide.✅ Checklist
pnpm test:pr.🚀 Release Impact
Summary by CodeRabbit
Documentation