Improve JavaScript components docs

Offen

#647 erstellt am 06.2.2022 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: javascript, python, react
Bereich: documentation, frontend

Rechercherichtung

Start by locating the existing custom component documentation and its super-simple-chart example. Review how the docs currently explain components, then add coverage for a Hello World example, event handling, JavaScript/Python data exchange, and using a ReactJS component; done means each proposed topic is documented with usable examples.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

priority-2-moderate type-docs

Current Situation

The current docs are sparse on information, making it hard for new users to develop custom components. In particular, we jump to a relatively complicated example with super-simple-chart without ever showing a "Hello World" example. Also, this example does not demonstrate interactivity.

Proposed Actions

Extend the docs to add the following information

Simple "Hello World"
Adding interactivity (event handling)
Sending arbitrary JS data to Python
Sending arbitrary Python data to JS
Using a ReactJS component in a custom component

Vorherrschende Sprache: Python
Sterne: 8.1k
Forks: 332
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus reactive-python/reactpy

Outdated GIF in Docs Offen

priority-3-low type-docs

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

reactive-python/reactpy#1034 · Erstellt am 09.6.2023
Allow JavaScript components inside of props dict Offen

priority-2-moderate type-revision

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy#1319 · Erstellt am 15.12.2025
Create PyScript-compatible interface for ReactPy SSR and ReactJS components Offen

priority-1-high

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy#1277 · Erstellt am 13.2.2025
Add MicroPython as ReactPy executor Offen

priority-3-low

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

reactive-python/reactpy#1273 · 1 Reaktion · Erstellt am 11.2.2025
ReactPy static site generation (SSG) Offen

priority-2-moderate

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100

reactive-python/reactpy#1272 · 2 Reaktionen · Erstellt am 11.2.2025

Alle Issues in reactive-python/reactpy