reactjs / reactjs/react.dev

[Typo]: createPortal documentation is pointing to an old page of W3C dialog modal docs.

Open
#6,951 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Summary

createPortal documentation redirect us to the wrong W3C guideline page (old page).

Page

https://react.dev/reference/react-dom/createPortal#usage

Details

The createPortal documentation (Pitfall section) has a link that points to the W3C guidelines page on how to make modals accessible.
Although, this link is an old one so this is not currently redirecting to the expected one. The new link is https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/.

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 createPortal documentation at the reported #usage section and inspect the link in its Pitfall section. Update the outdated W3C dialog-modal link to the current URL provided in the issue, then verify that the rendered documentation points to the expected page.

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
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.