[Suggestion]: Reference: component prop list shoud be more readable
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 11.8k
- Forks
- 7.9k
- Merge medio
- 1 d 11 h
- PR fusionados (30 d)
- 11
Descripción
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:
What it looks like with my suggestions applied:
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
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.
Evaluación
- Stack tecnológico
- javascript, react
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Tranquilo
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 45/100