Skip to main content

useI18nextDocument

Loads the i18next document for one language.

When to use it​

Language is required; an empty string disables the request.

Setup​

Call it from a client-side React component below OvokProvider so it uses the client configured at that provider boundary.

Hook arguments​

ArgumentTypeDetails
languagestringLanguage key; an empty value disables the request.

TypeScript signature​

(language: string): OvokRequestState<OvokI18nDocument>

Request state​

The response payload is OvokI18nDocument. A successful empty result, a failed request, and a request that has not returned data are distinct states.

FieldMeaning
dataLatest successful response, or undefined before one is available.
loadingWhether the request is in progress.
errorRequest error as an Error, or undefined when no request has failed.
reloadRepeats the request with the current arguments.

Request behavior​

The hook loads when its required inputs are available and reloads when those inputs change. Use reload for an explicit refresh; render loading, error, and successful no-result states separately.

Example​

Handle the hook's loading and error states before rendering the result.

import { useI18nextDocument } from '@ovok/core';

export function I18nextDocumentExample({ language }: { language: Parameters<typeof useI18nextDocument>[0] }) {
  const { data, loading, error, reload } = useI18nextDocument(language);
  if (loading) return <p>Loading…</p>;
  if (error) return <p role="alert">{error.message}</p>;
  return <section><button onClick={reload}>Reload</button><pre>{JSON.stringify(data, null, 2)}</pre></section>;
}