reactjs / reactjs/react.dev

[Suggestion]: Reference: component prop list shoud be more readable

Ouverte
#7,071 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

type: documentation
Langage dominant
JavaScript
Étoiles
11.8k
Forks
7.9k
Merge moyen
1 j 11 h
PR mergées (30 j)
11

Description

Summary

In my view, the current presentation of component props is somewhat unreadable and could benefit from refinement. This issue is particularly visible in long lists like this one: input props.

My propose is to improve indentations and alignment and to enhance visual clarity using existing tools:

  • for the long lists, to use table
  • for the short lists, to move description sentence into an inner nested list item and remove its bullet
  • to remove articles (a/an) before types

P.S. I know, this is a bit influenced by the MDN Web Docs, but those are not poor UX decisions. Nonetheless, I welcome an active discussion on these suggestions.

Page

No response

Details

What it looks like now:
Screenshot from 2024-07-20 13-29-40

What it looks like with my suggestions applied:
Screenshot from 2024-07-20 13-17-50

Guide de contribution

Ouvrir le guide de contribution

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.

Piste de recherche

Commencez par la page de référence liée sur les React input props et comparez sa présentation actuelle avec les captures d’écran fournies. Examinez les listes de props des autres composants afin d’identifier les cas de listes longues et courtes, puis étudiez les tableaux proposés, les descriptions imbriquées, l’alignement et la suppression de l’article ; le travail est terminé lorsque les pages de référence concernées présentent systématiquement une mise en forme plus claire.

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

Évaluation

Stack technique
javascript, react
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Calme
Clarté
À clarifier
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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