Skip to main content

useLocales

Loads locale configuration available to the current project.

When to use it​

Use this to populate locale selectors; it does not load localized content.

Setup​

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

Hook arguments​

The hook takes no arguments. It queries through the client configured in OvokProvider; call reload() to repeat the current request.

TypeScript signature​

(): OvokRequestState<OvokLocales>

Request state​

The response payload is OvokLocales. 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 { useLocales } from '@ovok/core';

export function LocalesExample() {
  const { data, loading, error, reload } = useLocales();
  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>;
}