solidjs / solidjs/solid-docs

[Content]: Typescript "Event handling" and "Advanced JSX attributes and directives" sections

Abierto
#569 0 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

good first issue help wanted planned solid
Lenguaje dominante
MDX
Estrellas
292
Forks
361
Merge medio
7 h 51 min
PR fusionados (30 d)
1

Descripción

📚 Subject area/topic

Typescript "Event handling" and "Advanced JSX attributes and directives" sections

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/configuration/typescript#event-handling
https://docs.solidjs.com/configuration/typescript#advanced-jsx-attributes-and-directives
https://docs.solidjs.com/configuration/typescript#custom-event-handlers

📋 Description of content that is out-of-date or incorrect
  • "Event handling" section and "custom event handler" section are split up, it makes more sense for these to be together
  • "custom event handler" section is currently under "Advanced JSX attributes and directives" along with "Forcing properties and custom attributes" and "Custom directives". I'm not sure it makes sense to have these split up. I feel like it would be easier to find if they were all just part of the list of API types. @LadyBluenotes let me know what you think about this one please.
  • "Forcing properties and custom attributes" and "Custom directives" are not a high enough level heading to show up in the page outline
  • "custom event handler" should be renamed since it also covers standard events, it is really just how to type on: both custom and standard events
  • standard events for on: are not included in SolidJS by default so the types have to be added manually, it should probably just be a subsection rather than a callout
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con las secciones de la página de TypeScript en los tres anclajes de documentación enlazados: Event handling, Advanced JSX attributes and directives y Custom event handlers. Revisa los encabezados y el contenido actuales; después, consolida y cambia el nombre de las secciones relevantes para que la estructura de la página y las indicaciones sobre la tipificación de eventos sean más claras. Se considera terminado cuando los temas afectados están agrupados lógicamente y describen con precisión tanto los eventos on: estándar como los personalizados.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
Medio día
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
38/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.