[Request]: Add Web Components Typing to the TypeScript guide
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 292
- Forks
- 361
- Avg merge
- 7h 51m
- Merged PRs (30d)
- 1
Description
What is this request related to?
Request
📋 Suggested
https://docs.solidjs.com/configuration/typescript#typescript
📋 General description or bullet points
It's come to my attention that we don't talk about how to use webcomponents in the new docs anywhere. There was an old discussion here: https://github.com/solidjs/solid/issues/616 that sheds some light but the answer is little bit lost.
It doesn't necessarily need to go in the TS section but it does feel like it makes sense because it uses similar overrides to custom events, props etc..
🖥️ Reproduction of code samples in StackBlitz
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 guide at docs.solidjs.com/configuration/typescript#typescript, then read the older Solid discussion in issue #616 for the missing Web Components context. Add guidance on Web Components typing, including the relevant overrides for custom events and props, and verify that the TypeScript guide clearly explains how to use it.
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
- 35/100