[Request]: Add Web Components Typing to the TypeScript guide
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation
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.
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
- Dominant language
- MDX
- Stars
- 292
- Forks
- 361
- Avg merge
- 7h 51m
- Merged PRs (30d)
- 1
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.
More from solidjs/solid-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
solidjs/solid-docs#1635 ·
-
good first issue solid solidstart
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
solidjs/solid-docs#1522 ·
-
pending review
solidjs/solid-docs#1637 · 1 assignee ·
-
help wanted
solidjs/solid-docs#1636 · 4 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
solidjs/solid-docs#1630 · 1 comment ·
All issues in solidjs/solid-docs
Similar issues
-
area:dictation documentation P2
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
uttrflow/uttrflow-swift#1180 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
githubnext/gh-aw-workshop#3692 ·
-
agent/guide documentation hive/hosted-available-lke648397-260827-5n31
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
falcosecurity/falco-website#1601 ·
-
specification
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
WICG/webmonetization#729 ·