solidjs / solidjs/solid-docs

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

Ouverte
#569 0 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

good first issue help wanted planned solid
Langage dominant
MDX
Étoiles
292
Forks
361
Merge moyen
7 h 51 min
PR mergées (30 j)
1

Description

📚 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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les sections de la page TypeScript correspondant aux trois ancres de documentation liées : Event handling, Advanced JSX attributes and directives et Custom event handlers. Examinez les titres et le contenu actuels, puis regroupez et renommez les sections pertinentes afin que le plan de la page et les indications sur le typage des événements soient plus clairs. Le travail est terminé lorsque les sujets concernés sont regroupés logiquement et décrivent correctement les événements on: standard et personnalisés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
Une demi-journée
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.