Integración de React: Documentación del Hook useDictionary

    Esta sección proporciona una guía detallada sobre el uso del hook useDictionary dentro de aplicaciones de React, habilitando el manejo eficiente de contenido localizado sin un editor visual.

    Importando useDictionary en React

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

    • Componente del Cliente:

      typescript
      import { useDictionary } from "react-intlayer"; // Usado en componentes de React del lado del cliente
    • Componente del Servidor:

      typescript
      import { useDictionary } from "react-intlayer/server"; // Usado en componentes de React del lado del servidor

    Parámetros

    El hook acepta dos parámetros:

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

    Declaración de Contenido

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

    ./component.content.ts
    import { t, type DeclarationContent } from "intlayer";const componentContent = {  key: "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 componentContent;

    Ejemplo de Uso en React

    A continuación se muestra un ejemplo de cómo usar el hook useDictionary en un componente de React:

    ./ComponentExample.tsx
    import type { FC } from "react";import { useDictionary } from "react-intlayer";import componentContent from "./component.content";const ComponentExample: FC = () => {  const { title, content } = useDictionary(componentContent);  return (    <div>      <h1>{title}</h1>      <p>{content}</p>    </div>  );};

    Integración del Servidor

    Si estás usando el hook useDictionary fuera del IntlayerProvider, el locale debe proporcionarse explícitamente como un parámetro al renderizar el componente:

    ./ServerComponentExample.tsx
    import type { FC } from "react";import { useDictionary } from "react-intlayer/server";import clientComponentExampleContent from "./component.content";const ServerComponentExample: FC<{ locale: string }> = ({ locale }) => {  const { content } = useDictionary(clientComponentExampleContent, locale);  return (    <div>      <h1>{content.title}</h1>      <p>{content.content}</p>    </div>  );};

    Notas sobre los Atributos

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

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

    Consejos Adicionales

    • Seguridad de Tipo: Siempre utiliza DeclarationContent para definir tus diccionarios para garantizar la seguridad de tipos.
    • Actualizaciones de Localización: Al actualizar contenido, asegúrate de que todos los locales 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 las 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