Accueil › Vue.js › Typer les props et les émissions
Typer les props et les émissions
Vue et TypeScriptavance
Dans <script setup lang="ts">, les props et les émissions se déclarent par
type. Le compilateur de SFC lit l'argument de type et en déduit la
déclaration d'exécution que Vue utilisera.
<script setup lang="ts">
interface Props {
titre: string
quantite?: number
tags: string[]
}
const props = defineProps<Props>()
const emit = defineEmits<{
sauver: [id: number]
annuler: []
}>()
</script>
Une prop optionnelle s'écrit avec ?. Elle vaut alors undefined quand le
parent ne la passe pas — sauf si on lui donne une valeur par défaut.
Deux façons de donner cette valeur. La déstructuration, stabilisée en Vue 3.5, qui reste réactive parce que le compilateur réécrit chaque accès :
const { titre, quantite = 1 } = defineProps<Props>()
Ou withDefaults, qui existait avant et fonctionne toujours :
const props = withDefaults(defineProps<Props>(), { quantite: 1 })
Côté émissions, la forme en tuple décrit la charge utile événement par
événement. emit('sauver', '42') devient une erreur de compilation, et le
parent qui écrit @sauver="(id) => ..." reçoit id déjà typé en number.
Un point à ne pas manquer : tsc ignore les fichiers .vue. C'est vue-tsc
qui les vérifie, bloc script et expressions du template compris. Sans lui, le
typage ne protège que l'éditeur.
Les termes à connaître
- Déclaration par type
Passer un argument de type à
defineProps—defineProps<{ titre: string }>()— au lieu d'un objet d'options. Le compilateur de SFC en déduit la déclaration d'exécution.- Déclaration d'exécution
La forme historique,
defineProps({ titre: { type: String, required: true } }). Elle existe toujours, et reste la seule possible hors de<script setup>.- withDefaults
Macro de compilation qui associe des valeurs par défaut à une déclaration de props faite par type. Elle n'existe que parce que l'argument de type ne peut pas porter de valeur.
- Déstructuration réactive des props
Déstructurer l'objet renvoyé par
definePropsdans<script setup>. Le compilateur réécrit chaque accès, si bien que la réactivité est préservée ; stabilisé en Vue 3.5. La valeur par défaut s'écrit alors avec=.- defineEmits en forme de type
defineEmits<{ sauver: [id: number] }>()déclare les événements et la forme exacte de leur charge utile. Un appel avec un mauvais nombre ou un mauvais type d'arguments est refusé à la compilation.- PropType
Utilitaire de
vuequi attache un type TypeScript à une optiontyped'exécution —type: Object as PropType<Produit>. C'est l'outil de l'Options API et des composants sans<script setup>.- vue-tsc
Le vérificateur de types des fichiers
.vue.tscseul ignore ces fichiers ; c'estvue-tscqui analyse le bloc script et les expressions du 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.