react.dev icon indicating copy to clipboard operation
react.dev copied to clipboard

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

Open alinkedd opened this issue 1 year ago • 1 comments
trafficstars

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

alinkedd avatar Jul 20 '24 10:07 alinkedd

Hi @alinkedd, actually you are right. It spoils the overall readability of the whole text. Fitting this inside a table would be a better option in terms of UX as well as readability.

poswalsameer avatar Oct 16 '24 14:10 poswalsameer