reactjs/react.dev

Mention that `Component.render` could return iterator

Open

#286 opened on Nov 14, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (7,898 forks)github user discovery
difficulty: mediumgood first issuetype: documentation

Repository metrics

Stars
 (11,763 stars)
PR merge metrics
 (Avg merge 37d 15h) (21 merged PRs in 30d)

Description

According to the discussion here https://github.com/facebook/react/issues/11502 it is legal to return iterators from Component.render. But it is not mentioned in the document.

Moreover -- it would work only in production mode, not in development. It should me mentioned that to make it work in both environments -- you should use iterable, rather than iterator (see this Seq approach from the Reach issue).

I suggest to place it around https://reactjs.org/docs/react-component.html#fragments

Contributor guide

Research direction
Review the discussion in the linked React issue to understand iterator vs iterable behavior, then update the React.Component documentation to mention that render can return iterators but only works in production, and suggest using iterables for both environments.
Tech stack
javascriptreact
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
React
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90