useSSRStatus

useSSRStatus() returns information about whether SSR data was used for consent manager initialization. This is primarily useful for debugging SSR data flow in Next.js or other server-rendering frameworks.

import { useSSRStatus } from '@c15t/react';

function DebugSSR() {
  const { ssrDataUsed, ssrSkippedReason } = useSSRStatus();

  if (ssrDataUsed) {
    return <span>Consent initialized from SSR data</span>;
  }

  return <span>SSR skipped: {ssrSkippedReason ?? 'unknown'}</span>;
}

Return Value

Property

Types

Loading…

Info

Must be used within a ConsentManagerProvider. Throws if used outside the provider context.

useSSRStatus

Return Value

ssrDataUsedWhether SSR data was used for initialization. true if SSR data was provided and successfully consumed, false otherwise.requiredboolean

ssrSkippedReasonReason SSR data was skipped, or null if used successfully. 'no_data' — no ssrData prop was provided to the provider 'fetch_failed' — ssrData was provided but the Promise resolved with no data required"no_data" | "fetch_failed" | null

ssrDataUsedWhether SSR data was used for initialization. true if SSR data was provided and successfully consumed, false otherwise.requiredboolean

ssrSkippedReasonReason SSR data was skipped, or null if used successfully. 'no_data' — no ssrData prop was provided to the provider 'fetch_failed' — ssrData was provided but the Promise resolved with no data required"no_data" | "fetch_failed" | null