openfunnel-doc-telemetry v2.0.1

OpenFunnel Telemetry

OpenFunnel Telemetry attaches to any React Component and is compatible with MDX, too.

Quick Integration

Just integrate our useOpenFunnelTelemetry hook and add a div. We take it from there!

Use Case: CodeBlock Interaction

Installation

To install the OpenFunnel Telemetry package, use npm:

npm install openfunnel-doc-telemetry

Usage

First, import the useOpenFunnelTelemetry hook into your component:

import { useOpenFunnelTelemetry } from "openfunnel-doc-telemetry";

Then, use the hook in your component like this:

const YourComponent: React.FC<Props> = ({
  ...props
}) => {

  const openfunneldiv = useOpenFunnelTelemetry({});

  return (
    <div ref={openfunneldiv}>
      {/* Rest of the tsx/jsx */}
    </div>
  );
};

Key Features

• Easy Integration: Attach the telemetry with a simple div element.
• MDX Compatible: Fully compatible with MDX for seamless usage in documentation.
• Automatic Tracking: Automatically tracks interactions within the component.