[Suggestion]: Reference: component prop list shoud be more readable
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 11.8k
- Fork
- 7.9k
- Merge medio
- 1g 11h
- PR unite (30g)
- 11
Descrizione
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:
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla pagina di riferimento collegata sui React input props e confronta la presentazione attuale con gli screenshot forniti. Esamina gli elenchi di props degli altri componenti per individuare i casi di elenchi lunghi e brevi, quindi considera le tabelle proposte, le descrizioni nidificate, l'allineamento e la rimozione dell'articolo; il lavoro è completato quando le pagine di riferimento interessate hanno una formattazione costantemente più chiara.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, react
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 45/100