Referência React

Ways

Root props

Propriedades de raiz comuns:

PropriedadeTipoNotas
apiKeystringObrigatório.
localizaçãostringLocalidade alvo atual.
baseLocalestringLocalização de origem.
persistLocaleCookiebooleanPolítica de cookies de localidade padrão para o runtime raiz.
contextostring | objetoContexto raiz opcional.
cacheTtlnúmeroTTL de cache para pedidos de tradução.
formatadorDeMensagem'waysParser' | 'nenhum' | fnSubstituição de parser ou formatador.
suspenseTimeoutMsnúmeroO tempo máximo em que o bloqueio de renderização é permitido antes de a renderização de recurso prosseguir.
fetchertypeof fetchImplementação de busca personalizada.
localesAceitesstring[]Lista de locais explícitos opcional.

Scoped props

Os escopos aninhados aceitam:

PropriedadeTipoNotas
contextostring | objetoObrigatório.
localizaçãostringDisponível, mas use uma raiz aninhada para uma sessão de locale isolada.
baseLocalestringSubstituição opcional da localidade de origem para a subárvore.
componentesRegistro<string, componente>Componentes utilizados dentro de conteúdo traduzível.

T

T é o primitivo de tradução em JSX.

PropriedadeTipoNotas
criançasReactNodeObrigatório.
varsRecord<string, desconhecido>Entrada de interpolação.
contextostring | objetoSubstituição de contexto de folha opcional.
componentesRegistro<string, componente>Mapeamento de componentes para conteúdo rico.
fixadobooleanPule a tradução para conteúdo fixo semelhante a marcas.

useT()

useT() retorna uma função de tradução para strings, atributos e lógica.

tsx
const t = useT();
const label = t('Save changes');

Ganchos de execução

useTranslatedMemo()

Um valor memorizado que é recalculado quando as traduções mudam.

useTranslationLoading()

Retorna true enquanto o contexto atual ainda está a carregar.

useCurrentLocale()

Lê a região selecionada para o runtime raiz atual.

useTargetLocale()

Lê a língua de destino ativa para o âmbito atual.

useBaseLocale()

Lê a localidade de origem para a runtime raiz atual.

useSetCurrentLocale()

Retorna o setter para a localidade de runtime raiz.

useAcceptedLocales()

Lê a lista de locais aceites resolvidos a partir do runtime raiz.

LanguageSwitcher

Propriedades comuns:

PropriedadeTipoNotas
currentLocalestringLocalidade controlada.
onLocaleChange(locale) => vazioManipulador de alterações.
direção'cima' | 'baixo'Direção do menu.
estilos / nomesDeClasseobjetoSubstituições de estilo.
sem estilobooleanDesativar estilos integrados.

Utility exports

@18ways/react também re-exporta:

  • fetchAcceptedLocales
  • fetchConfig
  • resolverOrigem
Referência do React