Intégration React : Documentation du hook useDictionary

Cette section fournit un guide détaillé pour utiliser le hook useDictionary dans les applications React, permettant une gestion efficace du contenu localisé sans éditeur visuel.

Importation de useDictionary dans React

Le hook useDictionary peut être intégré dans les applications React en l'important en fonction du contexte :

Composant Client :
import { useDictionary } from "react-intlayer"; // Utilisé dans les composants React côté client
Composant Serveur :
import { useDictionary } from "react-intlayer/server"; // Utilisé dans les composants React côté serveur

Paramètres

Le hook accepte deux paramètres :

dictionary : Un objet dictionnaire déclaré contenant le contenu localisé pour des clés spécifiques.
locale (optionnel) : La langue souhaitée. Par défaut, utilise la langue du contexte actuel si non spécifiée.

Déclaration du Contenu

Tous les objets dictionnaires doivent être déclarés dans des fichiers de contenu structurés pour garantir la sécurité des types et éviter les erreurs à l’exécution. Vous pouvez trouver les instructions de configuration ici. Voici un exemple de déclaration de contenu :

// ./component.content.ts

import { t, type DeclarationContent } from "intlayer";

const clientComponentExampleContent = {
  key: "client-component-example",
  content: {
    title: t({
      en: "Client Component Example",
      fr: "Exemple de composant client",
      es: "Ejemplo de componente cliente",
    }),
    content: t({
      en: "This is the content of a client component example",
      fr: "Ceci est le contenu d'un exemple de composant client",
      es: "Este es el contenido de un ejemplo de componente cliente",
    }),
  },
} satisfies DeclarationContent;

export default clientComponentExampleContent;

Exemple d'Utilisation dans React

Voici un exemple d'utilisation du hook useDictionary dans un composant React :

// ./ClientComponentExample.tsx

import { useDictionary } from "react-intlayer";
import clientComponentExampleContent from "./component.content";

const ClientComponentExample = () => {
  const { title, content } = useDictionary(clientComponentExampleContent);

  return (
    <div>
      <h1>{title}</h1>
      <p>{content}</p>
    </div>
  );
};

export default ClientComponentExample;

Intégration Serveur

Si vous utilisez le hook useDictionary en dehors de l’IntlayerProvider, la langue doit être explicitement fournie en paramètre lors du rendu du composant :

import { useDictionary } from "react-intlayer/server";
import clientComponentExampleContent from "./component.content";

const ServerComponentExample = ({ locale }: { locale: string }) => {
  const { content } = useDictionary(clientComponentExampleContent, locale);

  return (
    <div>
      <h1>{content.title}</h1>
      <p>{content.content}</p>
    </div>
  );
};

export default ServerComponentExample;

Remarques sur les Attributs

Contrairement aux intégrations utilisant des éditeurs visuels, des attributs comme buttonTitle.value ne s’appliquent pas ici. Accédez directement aux chaînes localisées telles qu'elles sont déclarées dans votre contenu.

<button title={content.title}>{content.content}</button>

Conseils Supplémentaires

Sécurité des Types : Utilisez toujours DeclarationContent pour définir vos dictionnaires et garantir la sécurité des types.
Mises à Jour de Localisation : Lors de la mise à jour du contenu, assurez-vous que toutes les langues sont cohérentes pour éviter les traductions manquantes.

Cette documentation se concentre sur l'intégration du hook useDictionary, offrant une approche simplifiée pour gérer le contenu localisé sans dépendre des fonctionnalités d'éditeurs visuels.

Si vous avez une idée d’amélioration pour améliorer cette documentation, n’hésitez pas à contribuer en submitant une pull request sur GitHub.

Lien GitHub de la documentation