patternfly / patternfly/patternfly-react

Templates(select) - improve documentation around initial selections

Aperta
#10,842 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

PF Team Stale
Lingua principale
TypeScript
Stelle
862
Fork
392
Merge medio
4g 8h
PR unite (30g)
9

Descrizione

The docs aren't clear about how to go about setting an initial selection for the different selects. It is the same pattern, and the examples use it (setting a selected prop on an option), but it would be helpful to explain this in the docs.

Also, currently you can still pass selected to the templates because the props tables extend SelectProps, but this is currently nonfunctional to a user since state is managed internally. My thought is we can exclude the prop from the extension, and potentially add an initialSelection prop as a more direct way of setting an initial selection (and an alternative to the option prop method that currently exists).


Jira Issue: PF-34

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Individua la documentazione del template, i relativi esempi di select e le tabelle delle props che estendono SelectProps; inizia confrontando come viene descritto il pattern esistente dell'opzione selezionata nei diversi select. Il lavoro è completato quando il comportamento della selezione iniziale è documentato chiaramente e la gestione nell'API di selected rispetto a una possibile prop initialSelection è risolta e riflessa in modo coerente.

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

Valutazione

Stack tecnologico
react, typescript
Ambito
documentation, frontend
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.