GuidesComponents

CMS hooks

Localized CMS content, legal pages, release notes, and i18next translations

  • Stable unknown
  • Release candidate since 1.16.1-rc.3
  • Development since 1.16.1-dev.2111+9796905

The @ovok/native/cms entry point provides hooks for reading Ovok CMS content with the app's current react-i18next language. These hooks expose request state for host-owned screens; they do not include visual components.

import {
  useCmsDocument,
  useCmsDocuments,
  useCmsLocale,
  useCmsTranslations,
  useLegalPage,
  useReleaseNotes,
} from "@ovok/native/cms";
HookUse it for
useCmsDocumentOne document from a named collection
useCmsDocumentsA page of documents from a collection
useLegalPageA tenant-scoped legal page, including before sign-in when tenantCode is provided
useReleaseNotesNewest-first release notes for a signed-in user
useCmsLocaleThe app language converted to an Ovok CMS locale
useCmsTranslationsLoading CMS translations into the i18next translation namespace

See the CMS guide for locale behavior, translation precedence, and an app-root setup. Browse the complete generated API reference for the signatures of each hook and its imported core types.

Last updated on