microsoft / microsoft/TypeScript

Add auto-completion results to CSSStyleDeclaration.{setProperty,removeProperty}

Offen
#38,956 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

Search Terms

setProperty

Suggestion

CSSStyleDeclaration.setProperty(propertyName, value, priority); is currently typed as setProperty(property: string, value: string | null, priority?: string | undefined): void.
There is a specific set of defined properties in CSS: https://www.w3.org/TR/CSS/#properties It would be great if this specific list of properties could be added to the definition, such that auto-completion would show the allowed values.

(The same is true for https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleDeclaration/removeProperty so this feature request applies to that method as well)

For backwards compatible reasons (and to be spec-compliant), a string overload would remain. That's because the following is legal, albeit a noop:

element.style.setProperty('non-existent', 'something');

Use Cases

Improved editor experience for style APIs.

Examples

With my cursor at |, ask for the auto-completions. The expected behavior would be to show the list of accepted properties, similar to how document.createElement works.

element.style.setProperty('|

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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 den Definitionen von CSSStyleDeclaration.setProperty und removeProperty und verwende die vorhandene Typisierung von document.createElement als Vergleich für das Verhalten bei der Vervollständigung. Die Arbeit ist abgeschlossen, wenn bekannte CSS-Eigenschaftsnamen in Vervollständigungsergebnissen erscheinen, während beliebige Zeichenfolgen aus Gründen der Rückwärtskompatibilität weiterhin akzeptiert werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
frontend, web-dev
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

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