TanStack / TanStack/form

[v2] Use consistent children syntax in React documentation and examples

Open
#2,304 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

scope: react type: docs v2
Dominant language
TypeScript
Stars
6.7k
Forks
682
Avg merge
5d 18h
Merged PRs (30d)
7

Description

The React documentation and examples should use one consistent style for passing children. The proposed convention is to use JSX children between a component's tags instead of passing them through the children prop.

This convention should be applied consistently across:

  • the documentation
  • the examples.

A consistent style would make the material easier to scan and prevent examples from switching between equivalent forms without a clear reason.

Optionally, the documentation could include a hidden hint explaining that children={} and JSX children are semantically equivalent. The hint could also mention that ESLint can be configured to report inconsistent usage.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the React documentation and examples, then search them for uses of the children prop and JSX children syntax. Update the applicable material to consistently use JSX children between component tags, and consider the optional hidden equivalence and ESLint hint. Done means the React documentation and examples no longer switch styles without a clear reason.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.