[Content]: Typescript "Event handling" and "Advanced JSX attributes and directives" sections
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 292
- Forks
- 361
- Avg merge
- 7h 51m
- Merged PRs (30d)
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the TypeScript page sections at the three linked documentation anchors: Event handling, Advanced JSX attributes and directives, and Custom event handlers. Review the current headings and content, then consolidate and rename the relevant sections so the page outline and event-typing guidance are clearer. Done means the affected topics are grouped logically and accurately describe both standard and custom on: events.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100