@ovok/native/cms

Hooks that read CMS content, locales and translations.

Import from @ovok/native/cms.

HooksCopy Anchor Link

useCmsDocument()Copy Anchor Link

function useCmsDocument<T>(
   collection,
   slug,
   options?
): OvokQueryState<T>;

Fetches one CMS document by collection and slug, in the current CMS locale unless options.locale is set; disabled while slug is undefined.

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OvokQueryState<T>

useCmsDocuments()Copy Anchor Link

function useCmsDocuments<T>(collection, options?): OvokQueryState<Page<T>>;

Fetches the documents of a CMS collection, in the current CMS locale unless options.locale is set.

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OvokQueryState<Page<T>>

useCmsLocale()Copy Anchor Link

function useCmsLocale(): string;

Returns the current i18n language as a CMS locale.

ReturnsCopy Anchor Link

string

useCmsTranslations()Copy Anchor Link

function useCmsTranslations(options?): OvokQueryState<OvokTranslations>;

Loads the CMS translations for the current or given locale and merges them into the app's i18n resources.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OvokQueryState<OvokTranslations>

useLegalPage()Copy Anchor Link

function useLegalPage(slug, options?): OvokQueryState<OvokCmsDocument>;

Fetches a legal page by slug, in the current CMS locale unless options.locale is set; disabled while slug is undefined.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OvokQueryState<OvokCmsDocument>

useReleaseNotes()Copy Anchor Link

function useReleaseNotes(options?): OvokQueryState<Page<OvokCmsDocument>>;

Fetches the release notes, in the current CMS locale unless options.locale is set.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OvokQueryState<Page<OvokCmsDocument>>