Contentful Personalization & Analytics
    Preparing search index...

    Interface OptimizationRootProps

    Props for the OptimizationRoot component.

    Accepts all CoreStatefulConfig properties directly. Only clientId is required.

    interface OptimizationRootProps {
        allowedEventTypes?: EventType[];
        api?: CoreStatefulApiConfig;
        children: ReactNode;
        clientId: string;
        contentfulLocales?: ContentfulLocales;
        defaults?: CoreConfigDefaults;
        environment?: string;
        eventBuilder?: EventBuilderConfig;
        fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">;
        getAnonymousId?: () => string | undefined;
        liveUpdates?: boolean;
        locale?: string;
        logLevel?: LogLevels;
        onEventBlocked?: (event: BlockedEvent) => void;
        onStatesReady?: OnStatesReady;
        previewPanel?: PreviewPanelConfig;
        queuePolicy?: QueuePolicy;
        trackEntryInteraction?: Partial<Record<EntryInteraction, boolean>>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowedEventTypes? api? children clientId contentfulLocales? defaults? environment? eventBuilder? fetchOptions? getAnonymousId? liveUpdates? locale? logLevel? onEventBlocked? onStatesReady? previewPanel? queuePolicy? trackEntryInteraction?

    Properties

    allowedEventTypes?: EventType[]

    Allow-listed event type strings permitted when consent is not set.

    api?: CoreStatefulApiConfig

    Unified API configuration for stateful environments.

    children: ReactNode

    Children components that will have access to the ContentfulOptimization instance.

    clientId: string

    Client identifier used for authentication or tracking.

    contentfulLocales?: ContentfulLocales

    Contentful locale configuration used to resolve the CDA locale.

    defaults?: CoreConfigDefaults

    Optional set of default values applied on initialization.

    environment?: string

    Contentful environment identifier.

    'main'

    eventBuilder?: EventBuilderConfig

    Event builder configuration (channel/library metadata, etc.).

    fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">

    Options used to configure the underlying protected fetch method.

    apiName is derived from the client name and must not be provided here.

    getAnonymousId?: () => string | undefined

    Function used to obtain an anonymous user identifier.

    liveUpdates?: boolean

    Whether OptimizedEntry components react to state changes in real time.

    false

    Live updates are always enabled when the preview panel is open, regardless of this setting.

    locale?: string

    Initial app/content locale candidate used to resolve the Contentful locale.

    logLevel?: LogLevels

    Minimum log level for the default console sink.

    onEventBlocked?: (event: BlockedEvent) => void

    Callback invoked whenever an event call is blocked by checks.

    onStatesReady?: OnStatesReady

    Called once SDK state initialization completes and before provider children mount. Return a cleanup function to unsubscribe app-level state observers on teardown.

    previewPanel?: PreviewPanelConfig

    Optional configuration for the preview panel. When provided with enabled: true, the preview panel will be available.

    queuePolicy?: QueuePolicy

    Unified queue policy for queued stateful work.

    trackEntryInteraction?: Partial<Record<EntryInteraction, boolean>>

    Controls which entry interactions are tracked automatically for all OptimizedEntry components. Individual components can override each interaction type with their trackViews and trackTaps props.

    { views: true, taps: false }

    Mirrors React Web's trackEntryInteraction pattern. Uses taps instead of clicks to match React Native terminology.

    <OptimizationRoot
      clientId="your-client-id"
      trackEntryInteraction={{ views: true, taps: true }}
    >
      <App />
    </OptimizationRoot>

    Settings

    Member Visibility

    On This Page

    Properties