reactjs / reactjs/react.dev

Document using HTML dialog element

Offen
#4,647 4 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
11.8k
Forks
7.9k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
11

Beschreibung

Modals/Dialogs are very common on the web. Now that the HTML dialog element has full cross-browser support it would be great to see documentation around how to use this in React as it is far from obvious. In the current docs it says "instead of exposing open() and close() methods on a Dialog component, pass an isOpen prop to it." Should people avoid using the showModal() function? Is it necessary to use portals when using a HTML dialog element?

Such a common UI task should be clearly documented.

<dialog> used to have some accessibility concerns but all of those have been addressed. It's now a much better option than implementing your own dialog. It has many accessibility features like 'inert' built-in.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Keine Dokumentationsdatei oder kein Test wird genannt. Beginne damit, die im Issue zitierte aktuelle React-Dokumentationsanleitung zu prüfen, und untersuche anschließend, wie das HTML dialog element, showModal() und portals gemeinsam verwendet werden sollten. Als erledigt gilt die Aufgabe, wenn die React-Dokumentation den empfohlenen Ansatz klar erklärt und die Frage beantwortet, ob showModal() und portals notwendig sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
html, javascript, react
Bereich
documentation, frontend
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.