microsoft / microsoft/TypeScript
Allow JSX element tags to be symbols
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
Search Terms
es6 symbols JSX createElement element tag type intrinsic host
Suggestion
Allow JSX element tags to be ES6 symbols instead of just strings, functions or classes.
Use Cases
JSX-based libraries like React have adopted the convention of using special upper-cased symbols as the tag of the JSX expression (<Fragment />, <Suspense />) as a way to provide intrinsic elements which aren’t callable and whose behavior are defined by the library rather than the tag.
Currently, TypeScript only allows JSX tags to be strings, functions or classes as defined by the JSX interface, and will throw errors like the following if Symbols are used:
error TS2604: JSX element type 'Fragment' does not have any construct or call signatures.
Libraries are therefore forced to lie about the actual typings of Symbol tags as something other than a unique symbol. For instance, React defines Symbol tags as ExoticComponent and pretends that the symbols are callable (https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/index.d.ts#L358-L364). The framework I work on (Crank.js) just defines symbols meant to be used as tags as any but this then has further repercussions when I attempt to, for instance, use these symbol types in interfaces.
Symbols are useful because they:
- Allow intrinsic elements to be upper-cased. This allows people to provide renderer-provided element APIs which mirror XML languages which are case-sensitive.
- Not globally scoped, so there is no possibility of namespace clashes, and can be imported/exported.
- Can still work with the global
IntrinsicElementsinterfaces to be strongly typed.
Examples
const Fragment = Symbol.for("crank.Fragment");
type Fragment = typeof Fragment;
const Portal = Symbol.for("crank.Portal");
type Portal = typeof Portal;
// should not error
const el = (
<Fragment>{children}</Fragment>
);
declare namespace JSX {
interface IntrinsicElements {
foo: any;
[Portal]: {root: any};
}
}
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Les points d’entrée de l’issue sont la vérification des types des éléments JSX et les déclarations de IntrinsicElements du namespace JSX ; commencez par retracer la façon dont les cas existants de chaînes, de fonctions et de classes sont validés. Comparez les exemples de Fragment et de Portal avec le diagnostic TS2604 actuel et définissez des tests pour le JSX avec des balises symbol et pour les clés symbol de IntrinsicElements ; le travail est considéré comme terminé lorsque les balises symbol valides sont acceptées sans modifier le JavaScript émis.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, typescript
- Domaine
- compilers
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 30/100