Contentful Personalization & Analytics
    Preparing search index...

    Interface UseViewportTrackingOptions

    Options for the useViewportTracking hook.

    interface UseViewportTrackingOptions {
        enabled?: boolean;
        entry: Entry;
        optimizationContextId?: string;
        selectedOptimization?: {
            experienceId: string;
            sticky?: boolean;
            variantIndex: number;
            variants: Record<string, string>;
        };
    }
    Index

    Properties

    enabled? entry optimizationContextId? selectedOptimization?

    Properties

    enabled?: boolean

    Whether view tracking is enabled for this entry. When false, the hook returns a no-op onLayout and isVisible: false without setting up timers or scroll listeners.

    true

    entry

    entry: Entry

    The resolved Contentful entry to track (baseline or variant).

    optimizationContextId?: string

    Opaque runtime-owned optimization context ID for event-stream enrichment.

    selectedOptimization?: {
        experienceId: string;
        sticky?: boolean;
        variantIndex: number;
        variants: Record<string, string>;
    }

    Selected optimization data for variant tracking. Omit for baseline/non-optimized entries.

    Type Declaration

    • experienceId: string

      Identifier of the personalization or experiment experience.

    • Optionalsticky?: boolean

      Indicates whether this optimization selection is sticky for the user.

      false

      Reuse sticky selections on subsequent requests for the same user rather than re-allocating a new variant.

    • variantIndex: number

      Index of the selected variant within the experience configuration.

      Typically corresponds to the index of the selected OptimizationConfig entry.

    • variants: Record<string, string>

      Mapping of baseline entry IDs to their selected variant entry IDs.

      The keys are component identifiers and the values are the identifiers of the selected variant for that component.

    Settings

    Member Visibility

    On This Page

    Properties