Skip to main content

useProjectSettings

Loads settings for the configured project.

When to use it​

Read current settings before presenting or applying project-level changes.

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<OvokProjectSettings>

Request state​

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

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