Formations — 1 037 leçons en français

Accueil › Vue.js › Extraire un composable

Extraire un composable

Les composablesintermediaire

Un composable est une fonction qui encapsule une logique avec état réactif. C'est la réponse de la Composition API à la question « comment réutiliser ce bout de code dans deux composants ».

Partez d'un composant qui suit la position de la souris.

<script setup>
import { ref, onMounted, onUnmounted } from 'vue'

const x = ref(0)
const y = ref(0)
function suivre(e) { x.value = e.pageX; y.value = e.pageY }

onMounted(() => window.addEventListener('mousemove', suivre))
onUnmounted(() => window.removeEventListener('mousemove', suivre))
</script>

<template>{{ x }} / {{ y }}</template>

Le même besoin apparaît ailleurs. On déplace les cinq lignes dans une fonction et on les renvoie.

// composables/useSouris.ts
import { ref, onMounted, onUnmounted } from 'vue'

export function useSouris() {
  const x = ref(0)
  const y = ref(0)
  function suivre(e: MouseEvent) { x.value = e.pageX; y.value = e.pageY }

  onMounted(() => window.addEventListener('mousemove', suivre))
  onUnmounted(() => window.removeEventListener('mousemove', suivre))

  return { x, y }
}

Le composant devient const { x, y } = useSouris().

Trois points font la convention. Le nom commence par use. La fonction renvoie un objet plat, pour que l'appelant déstructure et renomme. Et elle renvoie des ref, jamais x.value : une valeur nue serait copiée à la déstructuration et ne bougerait plus.

Les termes à connaître

Composable

Une fonction qui encapsule une logique avec état réactif, destinée à être appelée depuis <script setup> ou une autre fonction de mise en place.

Convention use

Le nom d'un composable commence par use. C'est une convention de nommage, pas une règle du compilateur, mais elle signale qu'on appelle quelque chose de réactif.

Logique de présentation

Ce qu'un composant fait en plus d'afficher : charger, filtrer, écouter, mémoriser. C'est cette part qui se déplace dans un composable.

toRefs

Transforme un objet réactif en objet plat dont chaque propriété est une ref. Il rend la déstructuration sûre à la sortie d'un composable.

Valeur de retour

Ce qu'un composable renvoie. Par convention, un objet plat de ref, de computed et de fonctions, pour permettre la déstructuration.

readonly

Enveloppe une source réactive dans une vue en lecture seule. Utile pour exposer un état sans autoriser l'appelant à l'écrire.

Lire l'explication détaillée et faire le quiz →

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.