Contenu de fichier / Intégration de fichiers dans Intlayer

Comment fonctionne l'intégration de fichiers

Dans Intlayer, la fonction file permet d'intégrer le contenu d'un fichier externe dans un dictionnaire. Cette approche garantit qu'Intlayer reconnaît le fichier source, permettant une intégration fluide avec l'éditeur visuel Intlayer et le CMS. Contrairement aux méthodes directes import, require ou de lecture de fichier via fs, l'utilisation de file associe le fichier au dictionnaire, ce qui permet à Intlayer de suivre et de mettre à jour dynamiquement le contenu lorsque le fichier est modifié.

Configuration du contenu de fichier

Pour intégrer le contenu d'un fichier dans votre projet Intlayer, utilisez la fonction file dans un module de contenu. Voici des exemples démontrant différentes implémentations.

import { file, type Dictionary } from "intlayer";

const myFileContent = {
  key: "my_key",
  content: {
    myFile: file("./path/to/file.txt"),
  },
} satisfies Dictionary;

export default myFileContent;

Utilisation du contenu de fichier dans React Intlayer

Pour utiliser un contenu de fichier intégré dans un composant React, importez et utilisez le hook useIntlayer depuis le paquet react-intlayer. Cela permet de récupérer le contenu à partir de la clé spécifiée et de l'afficher dynamiquement.

import type { FC } from "react";
import { useIntlayer } from "react-intlayer";

const FileComponent: FC = () => {
  const { myFile } = useIntlayer("my_key");

  return (
    <div>
      <pre>{myFile}</pre>
    </div>
  );
};

export default FileComponent;

Exemple de Markdown multilingue

Pour prendre en charge des fichiers Markdown éditables multilingues, vous pouvez utiliser file en combinaison avec t() et md() pour définir différentes versions linguistiques d'un fichier de contenu Markdown.

import { file, t, md, type Dictionary } from "intlayer";

const myMultilingualContent = {
  key: "ma_clef_multilingue",
  content: {
    myContent: md(
      t({
        en: file("src/components/test.en.md"),
        fr: file("src/components/test.fr.md"),
        es: file("src/components/test.es.md"),
      })
    ),
  },
} satisfies Dictionary;

export default myMultilingualContent;

Cette configuration permet de récupérer dynamiquement le contenu en fonction de la préférence linguistique de l'utilisateur. Lorsqu'elle est utilisée dans l'éditeur visuel Intlayer ou le CMS, le système reconnaît que le contenu provient des fichiers Markdown spécifiés et garantit qu'ils restent modifiables.

Comment Intlayer gère le contenu des fichiers

La fonction file est basée sur le module fs de Node.js pour lire le contenu du fichier spécifié et l'insérer dans le dictionnaire. Lorsqu'elle est utilisée en conjonction avec l'éditeur visuel Intlayer ou le CMS, Intlayer peut suivre la relation entre le dictionnaire et le fichier. Cela permet à Intlayer de :

• Reconnaître que le contenu provient d'un fichier spécifique.
• Mettre automatiquement à jour le contenu du dictionnaire lorsque le fichier lié est modifié.
• Assurer la synchronisation entre le fichier et le dictionnaire, préservant ainsi l'intégrité du contenu.

Ressources supplémentaires

Pour plus de détails sur la configuration et l'utilisation de l'intégration de fichiers dans Intlayer, consultez les ressources suivantes :

• Documentation CLI Intlayer
• Documentation React Intlayer
• Documentation Next Intlayer
• Documentation Contenu Markdown
• Documentation du contenu de traduction

Ces ressources offrent des informations complémentaires sur l'intégration de fichiers, la gestion de contenu et l'intégration d'Intlayer avec divers frameworks.