Improve JavaScript components docs

Ouverte
#647 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript, python, react
Domaine
documentation, frontend

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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
Langage dominant
Python
Étoiles
8.1k
Forks
332
Aucune PR mergée en 30 j

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de reactive-python/reactpy

Toutes les issues de reactive-python/reactpy

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.