solidjs / solidjs/solid-docs

[Request]: Add Web Components Typing to the TypeScript guide

Offen
#823 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

solid
Vorherrschende Sprache
MDX
Sterne
292
Forks
361
Ø Merge
7 Std. 51 Min.
Gemergte PRs (30 T.)
1

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem TypeScript-Leitfaden unter docs.solidjs.com/configuration/typescript#typescript und lies anschließend die ältere Solid-Diskussion im Issue #616, um den fehlenden Kontext zu Web Components zu erhalten. Ergänze Hinweise zur Typisierung von Web Components, einschließlich der relevanten Überschreibungen für benutzerdefinierte Events und Props, und verifiziere, dass der TypeScript-Leitfaden klar erklärt, wie man ihn verwendet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
Ein halber Tag
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.