solidjs / solidjs/solid-docs

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

Aperta
#569 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

good first issue help wanted planned solid
Lingua principale
MDX
Stelle
292
Fork
361
Merge medio
7h 51m
PR unite (30g)
1

Descrizione

📚 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

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

Inizia con le sezioni della pagina TypeScript nei tre ancoraggi della documentazione collegati: Event handling, Advanced JSX attributes and directives e Custom event handlers. Esamina i titoli e i contenuti attuali, quindi consolida e rinomina le sezioni pertinenti in modo che la struttura della pagina e le indicazioni sulla tipizzazione degli eventi siano più chiare. Il lavoro è completato quando gli argomenti interessati sono raggruppati logicamente e descrivono accuratamente sia gli eventi on: standard sia quelli personalizzati.

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

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
Mezza giornata
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.