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

Abierto
#7,071 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
javascript, react
Área
documentation

Línea de trabajo

Comienza con la página de referencia vinculada de React input props y compara su presentación actual con las capturas de pantalla proporcionadas. Revisa las listas de props de los demás componentes para identificar casos de listas largas y cortas, y considera después las tablas propuestas, las descripciones anidadas, la alineación y la eliminación del artículo; el trabajo estará terminado cuando las páginas de referencia afectadas tengan un formato más claro de manera uniforme.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

type: documentation
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

Lenguaje dominante
JavaScript
Estrellas
11.8k
Forks
7.9k
Merge medio
16 h 6 min
PR fusionados (30 d)
7

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de reactjs/react.dev

Todos los issues de reactjs/react.dev

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.