patternfly / patternfly/patternfly-react
Templates(select) - improve documentation around initial selections
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 862
- Forks
- 392
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 9
Descripción
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
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
Localiza la documentación de la plantilla, sus ejemplos de select y las tablas de props que extienden SelectProps; empieza comparando cómo se describe el patrón existente de la opción seleccionada en los distintos selects. Se considera terminado cuando el comportamiento de la selección inicial esté documentado con claridad y el tratamiento en la API de selected frente a un posible prop initialSelection esté resuelto y reflejado de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react, typescript
- Área
- documentation, frontend
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 55/100