Integração React: Documentação do Hook useDictionary

    Esta seção fornece orientações detalhadas sobre como usar o hook useDictionary em aplicações React, permitindo o gerenciamento eficiente de conteúdo localizado sem um editor visual.

    Importando useDictionary no React

    O hook useDictionary pode ser integrado em aplicações React importando-o com base no contexto:

    • Componente Cliente:

      typescript
      import { useDictionary } from "react-intlayer"; // Usado em componentes React no lado do cliente
    • Componente Servidor:

      typescript
      import { useDictionary } from "react-intlayer/server"; // Usado em componentes React no lado do servidor

    Parâmetros

    O hook aceita dois parâmetros:

    1. dictionary: Um objeto de dicionário declarado contendo conteúdo localizado para chaves específicas.
    2. locale (opcional): O idioma desejado. Por padrão, usa o idioma do contexto atual se não especificado.

    Dicionário

    Todos os objetos de dicionário devem ser declarados em arquivos de conteúdo estruturados para garantir segurança de tipo e evitar erros em tempo de execução. Você pode encontrar as instruções de configuração aqui. Aqui está um exemplo de declaração de conteúdo:

    ./component.content.ts
    import { t, type Dictionary } from "intlayer";const componentContent = {  key: "component-example",  content: {    title: t({      en: "Client Component Example",      fr: "Exemple de composant client",      es: "Ejemplo de componente cliente",      pt: "Exemplo 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 exemplo de componente cliente",      pt: "Este é o conteúdo de um exemplo de componente cliente",    }),  },} satisfies Dictionary;export default componentContent;

    Exemplo de Uso no React

    Abaixo está um exemplo de como usar o hook useDictionary em um componente 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>  );};

    Integração no Servidor

    Se você estiver usando o hook useDictionary fora do IntlayerProvider, o idioma deve ser explicitamente fornecido como um parâmetro ao renderizar o 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 Atributos

    Diferentemente de integrações que usam editores visuais, atributos como buttonTitle.value não se aplicam aqui. Em vez disso, acesse diretamente as strings localizadas conforme declarado no seu conteúdo.

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

    Dicas Adicionais

    • Segurança de Tipo: Sempre use Dictionary para definir seus dicionários e garantir segurança de tipo.
    • Atualizações de Localização: Ao atualizar o conteúdo, certifique-se de que todos os idiomas estejam consistentes para evitar traduções ausentes.

    Esta documentação foca na integração do hook useDictionary, fornecendo uma abordagem simplificada para gerenciar conteúdo localizado sem depender de funcionalidades de editores visuais.

    Se você tiver uma ideia para melhorar esta documentação, sinta-se à vontade para contribuir enviando uma pull request no GitHub.

    Link do GitHub para a documentação