Add hook usage examples as jsdoc/tsdoc
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- react, typescript
- Área
- documentation, frontend
Línea de trabajo
Review the repository's hook source and existing documentation to determine which hooks need examples and where their JSDoc or TSDoc belongs. Add brief usage examples or documentation links so they appear when hovering over each hook in an IDE, then verify the rendered documentation for the covered hooks.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Is your feature request related to a problem? Please describe.
To see examples for usage of a particular hook one needs to come to this repo taking them out of their flow.
Describe the solution you'd like
Examples and brief documentation should be in jsdoc/tsdoc format so that hook usage examples can be viewed in IDE by hovering over the hook.
Describe alternatives you've considered
Alternatively, just provide a link to the documentation for the hook
If I can get approval for this I'm happy to open a PR and contribute this.
- Lenguaje dominante
- TypeScript
- Estrellas
- 44k
- Forks
- 3.3k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la 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.
Más de streamich/react-use
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Add Generic Fn for useDebouncePosiblemente ocupada @itsmejay80 la tomó hace 189 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
-
useVideo.story.tsx - sampleVideo can not be loadedQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 62/100
-
useSlider: event callbacks are not updatedPosiblemente ocupada @erykpiast la tomó hace 1836 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Todos los issues de streamich/react-use
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
jbacalso24/mimry#459 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
architecture help wanted hive/claimed-by-architect origin/architect stage/030-pr-in-progress tech-debt
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
kubestellar/console#24422 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
area: backends type: docs
Dificultad 1/5 1-3 horas Aptitud para principiantes 83/100
schlessera/brain-kit#2383 ·
Los mantenedores suelen responder en 1 día
-
agent duplicate providers tool triaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día