Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Patternfly API docs - provide option to list all components alphabetically

Aperta
  • Qualcosa non va?
#4,443 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
documentation, frontend

Direzione di ricerca

Inizia esaminando la barra laterale della documentazione dell’API PatternFly e il suo punto di ingresso component-navigation esistente. Aggiungi un elenco alfabetico opzionale che mantenga l’organizzazione attuale e verifica che il layout della barra laterale rimanga invariato quando si cambia vista; esamina come potrebbe essere mantenuta la vista selezionata quando la documentazione viene riaperta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Is this a new component or an extension of an existing one?
Extension

What is the existing component, if any?
Patternfly API documentation

Describe the feature
It would be nice to have an option in the docs to list all PF components alphabetically in the side bar. For example, TextArea and TextInput are buried under the Forms heading, and Select and Dropdown are under the Menus heading. While this may make sense from a design standpoint, it does not really reflect how many users typically use API documentation. They're used to searching first, but if given a list, they would expect to see it listed alphabetically and not have to make a connection to how it's typically used. Having an alphabetical list would remove this need for abstraction. I've had to hunt myself a few times.

I don't want to take away from the current organization, given it was probably done to provide some organization to a long list. I would suggest making it optional, such as a link that says something like 'List all alphabetically' or something of that sort, and when clicked it replaces the existing list. Bonus points for saving this as the default when reopened.

Are there visuals for this feature? If applicable, please include examples for each state and for varying widths
Would just be the exact same layout, but replace default list with an alphabetical list in the sidebar.

Lingua principale
JavaScript
Stelle
74
Fork
148
Merge medio
3g 18h
PR unite (30g)
3

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di patternfly/patternfly-org

Tutte le issue di patternfly/patternfly-org

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.