Skip to main content

useLocalizations

Lists localization resources for one language.

When to use it​

An empty language disables the request; the response has total and resources fields.

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.
params (optional)OvokLocalizationQueryOptional localization filters.

TypeScript signature​

(language: string, params?: OvokLocalizationQuery): OvokRequestState<{ total: number; resources: OvokLocalization[]; }>

Request state​

The response payload is { total: number; resources: OvokLocalization[]; }. 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 { useLocalizations } from '@ovok/core';

export function LocalizationsExample({ language, params }: { language: Parameters<typeof useLocalizations>[0]; params?: Parameters<typeof useLocalizations>[1] }) {
  const { data, loading, error, reload } = useLocalizations(language, params);
  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>;
}