next-facebook-tracking/dist/components/pageview.d.ts

A simple package to help you integrate Facebook Pixel and Conversions API with Next.js

import { Facebook } from '../types.js';

/**
 * Component that tracks page views using Facebook Pixel whenever the pathname
 * or search params change.
 */
declare function FacebookPageView({ event, action, ...rest }: {
    /**
     * The event to track that will be sent to Facebook when the component is clicked.
     */
    event?: {
        /**
         * The ID of the event.
         *
         * @default uuidv7()
         */
        event_id?: string;
        /**
         * Additional custom data for the event.
         */
        custom_data?: Facebook.Event.PageView;
    };
    /**
     * The clickable content to render inside the component.
     */
    /**
     * A server-side action that will be called after the click handler is called.
     */
    action?: (props: {
        /**
         * The ID of the event.
         */
        event_id: string;
        /**
         * The name of the event.
         */
        event_name: 'PageView';
        /**
         * Additional custom data for the event.
         */
        custom_data?: Facebook.Event.PageView;
    }) => Promise<void>;
}): null;

export { FacebookPageView };