Improve JavaScript components docs

Aperta
#647 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript, python, react
Ambito
documentation, frontend

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Python
Stelle
8.1k
Fork
332
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di reactive-python/reactpy

Tutte le issue di reactive-python/reactpy

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.