Skip to content

Docs: Adding Multistep form example#2114

Closed
HM-23-HM wants to merge 2 commits intoTanStack:mainfrom
HM-23-HM:main
Closed

Docs: Adding Multistep form example#2114
HM-23-HM wants to merge 2 commits intoTanStack:mainfrom
HM-23-HM:main

Conversation

@HM-23-HM
Copy link
Copy Markdown
Contributor

@HM-23-HM HM-23-HM commented Apr 9, 2026

🎯 Changes

✅ 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).

This is a docs-only change. I've noticed that other form libraries have a multistep form example, so I believe that TanStack Form could benefit from one as well. I'm open to feedback.

Summary by CodeRabbit

  • New Features

    • Added a new multistep form example featuring step navigation and form validation.
  • Documentation

    • Updated navigation to include the new multistep form example with setup instructions and dependency information.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

A new React multistep form example is added to the documentation with complete project scaffolding. The example demonstrates form handling using TanStack React Form and Zod validation with step-by-step navigation. All necessary configuration files, dependencies, and build tooling are included.

Changes

Cohort / File(s) Summary
Navigation & Documentation
docs/config.json, examples/react/multistep/README.md
Added navigation entry for the multistep form example and basic setup instructions.
Project Configuration
examples/react/multistep/package.json, examples/react/multistep/tsconfig.json, examples/react/multistep/.eslintrc.cjs, examples/react/multistep/.gitignore
Configured Node project with dependencies (React 19, TanStack React Form, Zod), build scripts (Vite dev server on port 3001), TypeScript strict mode, ESLint rules, and standard development artifact ignores.
Entry Points
examples/react/multistep/index.html
Root HTML document with favicon link, viewport metadata, and mounts React app to #root element via TypeScript entry script.
Form Implementation
examples/react/multistep/src/index.tsx
Core example implementing a two-step form with Zod schema validation, custom FieldUI component for controlled inputs, step-based field validation via validateFieldGroup, and form submission handling using TanStack React Form and Devtools integration.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A hop, skip, and form in the React garden grows,
With Zod's watchful eyes and TanStack's gentle flows,
Step by step through validation's dance so bright,
A multistep example, polished just right! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding a multistep form example to the documentation/examples.
Description check ✅ Passed The description uses the required template structure with all sections present, but the 'Changes' section lacks substantive detail about what was added beyond a brief statement.

✏️ 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.

@nx-cloud
Copy link
Copy Markdown

nx-cloud bot commented Apr 9, 2026

View your CI Pipeline Execution ↗ for commit 4ba50a7


☁️ Nx Cloud last updated this comment at 2026-04-09 00:04:40 UTC

@crutchcorn
Copy link
Copy Markdown
Member

Closing, as we have intentionally omitted this information until we have our relevant API released for this.

@crutchcorn crutchcorn closed this Apr 9, 2026
@HM-23-HM
Copy link
Copy Markdown
Contributor Author

HM-23-HM commented Apr 9, 2026

Closing, as we have intentionally omitted this information until we have our relevant API released for this.

That was fast lol. Looking forward to it.

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.

2 participants