Integración en React: Documentación del hook useDictionary

Esta sección proporciona una guía detallada para usar el hook useDictionary en aplicaciones React, permitiendo una gestión eficiente del contenido localizado sin necesidad de un editor visual.

Importar useDictionary en React

El hook useDictionary puede integrarse en aplicaciones React importándolo según el contexto:

Componente Cliente:
import { useDictionary } from "react-intlayer"; // Para usar en componentes React del lado cliente
Componente Servidor:
import { useDictionary } from "react-intlayer/server"; // Para usar en componentes React del lado servidor

Parámetros

El hook acepta dos parámetros:

dictionary: Un objeto de diccionario declarado que contiene contenido localizado para claves específicas.
locale (opcional): El idioma deseado. Si no se especifica, utiliza el idioma del contexto actual por defecto.

Declaración del Contenido

Todos los objetos de diccionario deben declararse en archivos de contenido estructurados para garantizar la seguridad de tipos y evitar errores en tiempo de ejecución. Puedes encontrar las instrucciones de configuración aquí. A continuación, un ejemplo de declaración de contenido:

// ./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;

Ejemplo de Uso en React

A continuación, un ejemplo de cómo usar el hook useDictionary en un componente 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;

Integración en el Servidor

Si utilizas el hook useDictionary fuera del IntlayerProvider, el idioma debe proporcionarse explícitamente como parámetro al renderizar el componente:

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;

Notas sobre los Atributos

A diferencia de las integraciones que usan editores visuales, atributos como buttonTitle.value no se aplican aquí. En su lugar, accede directamente a las cadenas localizadas tal como se declaran en tu contenido.

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

Consejos Adicionales

Seguridad de Tipos: Utiliza siempre DeclarationContent para definir tus diccionarios y garantizar la seguridad de los tipos.
Actualizaciones de Localización: Cuando actualices contenido, asegúrate de que todos los idiomas sean consistentes para evitar traducciones faltantes.

Esta documentación se centra en la integración del hook useDictionary, proporcionando un enfoque simplificado para gestionar contenido localizado sin depender de funcionalidades de editores visuales.

Si tienes una idea para mejorar esta documentación, no dudes en contribuir enviando una pull request en GitHub.

Enlace de GitHub a la documentación