Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oppla.ai/llms.txt

Use this file to discover all available pages before exploring further.

Disable Tracking

Learn how to disable tracking in your tours for development or testing purposes.

Basic Usage

Disable Tracking Globally

import { createTour, TourManager } from '@oppla-ai/tours';

// Create tour manager
const manager = new TourManager();

// Configure to disable tracking
manager.configure({
  tracking: {
    enabled: false
  }
});

Disable Tracking for Specific Tour

// Create a tour with tracking disabled
const tour = createTour({
  id: 'feature-tour',
  steps: [
    {
      type: 'tooltip',
      target: '#feature-button',
      content: 'Try our new feature!'
    }
  ],
  tracking: {
    enabled: false
  }
});

Advanced Features

Conditional Tracking

// Create a tour with conditional tracking
const tour = createTour({
  id: 'feature-tour',
  steps: [
    {
      type: 'tooltip',
      target: '#feature-button',
      content: 'Try our new feature!'
    }
  ],
  tracking: {
    enabled: process.env.NODE_ENV === 'production'
  }
});

Selective Tracking

// Create a tour with selective tracking
const tour = createTour({
  id: 'feature-tour',
  steps: [
    {
      type: 'tooltip',
      target: '#feature-button',
      content: 'Try our new feature!',
      tracking: {
        enabled: false
      }
    },
    {
      type: 'modal',
      content: 'Welcome to our app!',
      tracking: {
        enabled: true
      }
    }
  ]
});

Best Practices

  1. Be Consistent: Use consistent tracking settings
  2. Be Clear: Document tracking configuration
  3. Be Secure: Protect sensitive data
  4. Be Efficient: Only track necessary events

Common Issues

Tracking Not Disabled

  • Check configuration
  • Verify environment
  • Check for overrides
  • Ensure proper initialization

Data Privacy

  • Review tracked data
  • Check for sensitive information
  • Verify compliance
  • Monitor data usage

Next Steps

Tooltips

Learn about tooltip steps

Modals

Learn about modal steps