Accueil › Vue.js › defineProps avec un type générique
defineProps avec un type générique
Vue et TypeScriptavance
Un composant de liste est générique par nature : il affiche des Produit, des
Client, des Ligne. Sans paramètre de type, la prop devient unknown[] ou
any[], et tout contrôle disparaît.
L'attribut generic sur <script setup>, disponible depuis Vue 3.3, déclare ce
paramètre.
<script setup lang="ts" generic="T">
defineProps<{
elements: T[]
selection: T | null
}>()
const emit = defineEmits<{ choisir: [element: T] }>()
</script>
À l'usage, T est déduit des props passées. Si elements reçoit un tableau
de Produit, alors selection doit être un Produit ou null, et le
gestionnaire @choisir reçoit un Produit.
On contraint T quand le composant lit quelque chose dans les éléments.
<script setup lang="ts" generic="T extends { id: string | number }">
const props = defineProps<{ elements: T[] }>()
const premier = props.elements[0]?.id // autorisé grâce à la contrainte
</script>
Sans contrainte, T n'a aucune propriété connue et element.id est refusé.
Dernier maillon : les emplacements. defineSlots propage T jusqu'au contenu
fourni par le parent.
defineSlots<{ default(props: { element: T }): any }>()
Sans cette déclaration, <template #default="{ element }"> donne un element
en any chez le parent, et la généricité s'arrête à la frontière du composant.
Les termes à connaître
- Attribut generic
<script setup lang="ts" generic="T">déclare un paramètre de type pour tout le composant. Disponible depuis Vue 3.3, il exigelang="ts".- Paramètre de type
Une variable de type — ici
T— dont la valeur est décidée à chaque utilisation du composant, d'après les props qu'on lui passe.- Contrainte
generic="T extends { id: string | number }"limite les types acceptables pourT, et permet d'accéder àidà l'intérieur du composant.- Liaison du paramètre
Le processus par lequel TypeScript déduit
Tà partir des arguments réels. Deux props qui réclament desTdifférents créent un conflit, signalé à la compilation.- defineSlots
Macro qui déclare le type des emplacements et de leurs props d'emplacement —
defineSlots<{ default(p: { item: T }): any }>(). C'est ce qui propageTjusqu'au contenu fourni par le parent.- Type d'instance
Le type d'un composant monté, obtenu d'ordinaire par
InstanceType<typeof Comp>. Un composant générique n'en a pas un seul, ce qui complique le typage d'une référence de template.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.