Skip to main content

useReleaseNotes

Loads one page from the release-notes CMS collection.

When to use it​

Results sort newest published first by default; this collection requires a session.

Setup​

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

Hook arguments​

ArgumentTypeDetails
options (optional)OvokCmsListOptionsTyped query or list options; see the API reference for its complete field contract.

TypeScript signature​

(options?: OvokCmsListOptions): OvokRequestState<OvokCmsPage>

Request state​

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

export function ReleaseNotesExample({ options }: { options?: Parameters<typeof useReleaseNotes>[0] }) {
  const { data, loading, error, reload } = useReleaseNotes(options);
  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>;
}