reactjs / reactjs/react.dev

suggestion for the first example in Render Props section

Open
#1,124 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

Currently the first example we see reads:

<DataProvider render={data => (
  <h1>Hello {data.target}</h1>
)}/>

Why not extend this initial example further and show what a DataProvider component might look like?
e.g. something like...

const DataProvider = props => {
  const data = {
    target: "World"
  }
  return props.render(data);
}

Granted, this is a fairly dumb example and not something you'd use a render prop for, but a dumb example might help solidify the basic concept before leading into more useful examples and conversations. Thoughts?

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

Open the Render Props section and review its first example alongside the proposed DataProvider example in the issue. Update the introductory example to make the provider implementation and render prop relationship clearer; done when the basic concept is understandable before the later examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.