reactjs / reactjs/react.dev

Contributing Controlled-components mental-model diagrams

Open
#5,003 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
11.8k
Forks
7.9k
Avg merge
1d 11h
Merged PRs (30d)
11

Description

Hi,

I don't really know where this could be integrated into the documentation, but I've created some visuals to explain step-by-step what really happens when interacting with a Controlled-component, for each field type:

  • text field
    Textfield controlled-component
  • select:
    Select controlled-component
  • multiple select:
    SelectMultiple controlled-component
  • checkbox:
    Checkbox controlled-component
  • radio:
    RadioButtons controlled-component

I'd love to contribute those diagrams to the reactjs.org project if you think it can be useful.

I have them in SVG
I can edit/adapt them as needed
I can easily create a PR

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

Review the existing react.dev documentation structure to find where controlled-component guidance could fit. Inspect the supplied SVG diagrams for the text field, select, multiple select, checkbox, and radio examples, then confirm how they should be adapted and integrated; done means the diagrams are accepted into an appropriate documentation page.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.