reactjs / reactjs/react.dev

Clarify portals docs

Open
#840 2 comments 2 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

https://reactjs.org/docs/portals.html

We should make it clearer in the first paragraph it’s not imperative and doesn’t “work” outside of render. There is a common confusion that this should be called in lifecycles (where it has no effect).

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 with the first paragraph at https://reactjs.org/docs/portals.html and review its explanation of portals, render, and lifecycles. Done means making clear that portals are not imperative and do not work when called from lifecycle methods.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.