Intégration React : Documentation du Hook useIntlayerAsync

Le hook useIntlayerAsync étend la fonctionnalité de useIntlayer en ne se contentant pas de retourner des dictionnaires pré-rendus, mais en récupérant également les mises à jour de manière asynchrone, ce qui le rend idéal pour les applications qui mettent fréquemment à jour leur contenu localisé après le rendu initial.

Vue d'ensemble

• Chargement asynchrone des dictionnaires :
  Lors du montage initial, useIntlayerAsync retourne d'abord tout dictionnaire de locale pré-récupéré ou empaqueté statiquement (tout comme useIntlayer le ferait), puis récupère et fusionne de manière asynchrone tout dictionnaire distant nouvellement disponible.
• Gestion de l'état de progression :
  Le hook fournit également un état isLoading, indiquant lorsqu'un dictionnaire distant est en cours de récupération. Cela permet aux développeurs d'afficher des indicateurs de chargement ou des états de squelette pour une expérience utilisateur plus fluide.

Configuration de l'environnement

Intlayer fournit un système de gestion de source de contenu (CSM) sans interface (headless) qui permet aux non-développeurs de gérer et de mettre à jour le contenu des applications de manière fluide. En utilisant le tableau de bord intuitif d'Intlayer, votre équipe peut éditer les textes localisés, les images et d'autres ressources sans modifier directement le code. Cela simplifie le processus de gestion de contenu, favorise la collaboration et garantit que les mises à jour peuvent être effectuées rapidement et facilement.

Pour commencer avec Intlayer :

1. Inscrivez-vous et obtenez un jeton d'accès sur https://intlayer.org/dashboard.

2. Ajoutez les identifiants à votre fichier de configuration :
   Dans votre projet React, configurez le client Intlayer avec vos identifiants :

   intlayer.config.ts

   Copier le code

   Copier le code dans le presse-papiers

   import type { IntlayerConfig } from "intlayer";export default {  // ...  editor: {    clientId: process.env.INTLAYER_CLIENT_ID,    clientSecret: process.env.INTLAYER_CLIENT_SECRET,  },} satisfies IntlayerConfig;

3. Pousser un nouveau dictionnaire de langue vers Intlayer :

   bash

   Copier le code

   Copier le code dans le presse-papiers

   npx intlayer dictionary push -d my-first-dictionary-key

   Cette commande télécharge vos dictionnaires de contenu initiaux, les rendant disponibles pour une récupération et une édition asynchrones via la plateforme Intlayer.

Importer useIntlayerAsync dans React

Dans vos composants React, importez useIntlayerAsync :

import { useIntlayerAsync } from "react-intlayer";

Paramètres

1. key :
   Type : DictionaryKeys
   La clé du dictionnaire utilisée pour identifier le bloc de contenu localisé. Cette clé doit être définie dans vos fichiers de déclaration de contenu.

2. locale (optionnel) :
   Type : Locales
   La locale spécifique que vous souhaitez cibler. Si elle est omise, le hook utilise la locale du contexte Intlayer actuel.

3. isRenderEditor (optionnel, par défaut à true) :
   Type : boolean
   Détermine si le contenu doit être prêt à être rendu avec la superposition de l'éditeur Intlayer. Si défini à false, les données du dictionnaire retournées excluront les fonctionnalités spécifiques à l'éditeur.

Valeur de retour

Le hook retourne un objet dictionnaire contenant le contenu localisé indexé par key et locale. Il inclut également un booléen isLoading indiquant si un dictionnaire distant est en cours de récupération.

Exemple d'utilisation dans un composant React

import { useEffect, type FC } from "react";import { useIntlayerAsync } from "react-intlayer";export const ComponentExample: FC = () => {  const { title, description, isLoading } = useIntlayerAsync("async-component");  useEffect(() => {    if (isLoading) {      console.log("Le contenu est en cours de chargement...");    }  }, [isLoading]);  return (    <div>      {isLoading ? (        <div>          <h1>Chargement…</h1>          <p>Veuillez patienter pendant la mise à jour du contenu.</p>        </div>      ) : (        <div>          <h1>{title.value}</h1>          <p>{description.value}</p>        </div>      )}    </div>  );};

Points clés :

• Lors du rendu initial, title et description proviennent du dictionnaire de locale préchargé ou intégré statiquement.
• Tant que isLoading est true, une requête en arrière-plan récupère un dictionnaire mis à jour.
• Une fois la récupération terminée, title et description sont mis à jour avec le contenu le plus récent, et isLoading revient à false.

Gestion de la localisation des attributs

Vous pouvez également récupérer des valeurs localisées pour divers attributs HTML (par exemple, alt, title, aria-label) :

<img src={title.image.src.value} alt={title.image.alt.value} />

Fichiers de dictionnaire

Toutes les clés de contenu doivent être définies dans vos fichiers de déclaration de contenu pour garantir la sécurité des types et éviter les erreurs à l'exécution. Ces fichiers permettent la validation TypeScript, assurant que vous référencez toujours des clés et des locales existantes.

Les instructions pour configurer les fichiers de déclaration de contenu sont disponibles ici.

Informations complémentaires

• Éditeur Visuel Intlayer :
  Intégrez l’éditeur visuel Intlayer pour gérer et éditer le contenu directement depuis l’interface utilisateur. Plus de détails ici.

En résumé, useIntlayerAsync est un hook React puissant conçu pour améliorer l'expérience utilisateur et maintenir la fraîcheur du contenu en fusionnant des dictionnaires pré-rendus ou pré-récupérés avec des mises à jour asynchrones des dictionnaires. En tirant parti de isLoading et des déclarations de contenu basées sur TypeScript, vous pouvez intégrer de manière transparente un contenu dynamique et localisé dans vos applications React.

Historique de la documentation

• 5.5.10 - 2025-06-29 : Historique initial