Next.js Integração: Documentação do Hook useIntlayerAsync

O hook useIntlayerAsync estende a funcionalidade do useIntlayer ao não apenas retornar dicionários pré-renderizados, mas também buscar atualizações de forma assíncrona, tornando-o ideal para aplicativos que frequentemente atualizam seu conteúdo localizado após a renderização inicial.

Visão Geral

• Carregamento Assíncrono de Dicionário:
  No lado do cliente, o useIntlayerAsync primeiro retorna o dicionário de localidade pré-renderizado (assim como o useIntlayer) e então busca e mescla assíncronamente quaisquer novos dicionários remotos disponíveis.
• Gestão de Estado de Progresso:
  O hook também fornece um estado isLoading, indicando quando um dicionário remoto está sendo buscado. Isso permite que os desenvolvedores exibam indicadores de carregamento ou estados de esqueleto para uma experiência do usuário mais suave.

Configuração do Ambiente

Intlayer fornece um sistema de Gestão de Fonte de Conteúdo (CSM) sem cabeça que capacita não desenvolvedores a gerenciar e atualizar o conteúdo do aplicativo de forma contínua. Usando o painel intuitivo do Intlayer, sua equipe pode editar textos localizados, imagens e outros recursos sem modificar diretamente o código. Isso simplifica o processo de gestão de conteúdo, promove a colaboração e garante que as atualizações possam ser feitas de forma rápida e fácil.

Para começar com o Intlayer, você primeiro precisará se registrar e obter um token de acesso em /dashboard. Depois de obter suas credenciais, adicione-as ao seu arquivo de configuração conforme mostrado abaixo:

import type { IntlayerConfig } from "intlayer";export default {  // ...  editor: {    clientId: process.env.INTLAYER_CLIENT_ID,    clientSecret: process.env.INTLAYER_CLIENT_SECRET,  },} satisfies IntlayerConfig;

Após configurar suas credenciais, você pode enviar um novo dicionário de localidade para o Intlayer executando:

npx intlayer dictionary push -d my-first-dictionary-key

Esse comando faz o upload de seus dicionários de conteúdo iniciais, tornando-os disponíveis para busca assíncrona e edição através da plataforma Intlayer.

Importando useIntlayerAsync no Next.js

Como useIntlayerAsync é destinado a componentes do lado do cliente, você importará a partir do mesmo ponto de entrada do cliente que useIntlayer:

"use client";import { useIntlayerAsync } from "next-intlayer";

Certifique-se de que o arquivo de importação esteja anotado com "use client" no topo, se você estiver usando o Next.js App Router com componentes do servidor e cliente separados.

Parâmetros

1. key:
   Tipo: DictionaryKeys
   A chave do dicionário usada para identificar o bloco de conteúdo localizado. Essa chave deve ser definida em seus arquivos de declaração de conteúdo.

2. locale (opcional):
   Tipo: Locales
   O locale específico que você deseja direcionar. Se omitido, o hook usa o locale do contexto do cliente.

3. isRenderEditor (opcional, padrão é true):
   Tipo: boolean
   Determina se o conteúdo deve estar pronto para renderização com a sobreposição do editor do Intlayer. Se definido como false, os dados do dicionário retornados excluirão recursos específicos do editor.

Valor de Retorno

O hook retorna um objeto de dicionário contendo conteúdo localizado indexado por key e locale. Também inclui um booleano isLoading indicando se um dicionário distante está atualmente sendo buscado.

Exemplo de Uso no Next.js

Exemplo de Componente do Lado do Cliente

"use client";import { useEffect, type FC } from "react";import { useIntlayerAsync } from "next-intlayer";export const AsyncClientComponentExample: FC = () => {  const { title, description, isLoading } = useIntlayerAsync("async-component");  useEffect(() => {    if (isLoading) {      console.log("O conteúdo está carregando...");    }  }, [isLoading]);  return (    <div>      <h1>{title.value}</h1>      <p>{description.value}</p>    </div>  );};

Pontos Chave:

• Na renderização inicial, title e description vêm do dicionário de localidade pré-renderizado.
• Enquanto isLoading for true, uma requisição remota é feita em segundo plano para buscar um dicionário atualizado.
• Assim que a busca é concluída, title e description são atualizados com o conteúdo mais recente, e isLoading retorna a false.

Tratando a Localização de Atributos

Assim como no useIntlayer, você pode recuperar valores de atributos localizados para várias propriedades HTML (por exemplo, alt, title, aria-label):

<img src={title.image.src.value} alt={title.image.alt.value} />

Arquivos de Declaração de Conteúdo

Todas as chaves de conteúdo devem ser definidas em seus arquivos de declaração de conteúdo para segurança de tipo e para prevenir erros em tempo de execução. Esses arquivos permitem a validação do TypeScript, garantindo que você sempre faça referência a chaves e locales existentes.

Instruções para configurar arquivos de declaração de conteúdo estão disponíveis aqui.

Informações Adicionais

• Editor Visual Intlayer:
  Integre-se ao editor visual do Intlayer para gerenciar e editar conteúdo diretamente da interface do usuário. Mais detalhes aqui.

Em resumo, o useIntlayerAsync é um poderoso hook do lado do cliente projetado para melhorar a experiência do usuário e manter a frescura do conteúdo ao casar dicionários pré-renderizados com atualizações assíncronas de dicionário. Ao alavancar isLoading e declarações de conteúdo baseadas em TypeScript, você pode integrar facilmente conteúdo dinâmico e localizado em suas aplicações Next.js.