posthog-tours
Version:
A TypeScript package for creating guided tours in PostHog
51 lines (48 loc) • 1.92 kB
JavaScript
;
// Main entry point for posthog-tours
// Export your public API here
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.PostHogTours = exports.VERSION = void 0;
exports.VERSION = '0.1.0';
var PostHogTours_1 = require("./PostHogTours");
Object.defineProperty(exports, "PostHogTours", { enumerable: true, get: function () { return PostHogTours_1.PostHogTours; } });
__exportStar(require("./types"), exports);
// Example usage:
/*
import { PostHogTours } from 'posthog-tours';
// Initialize PostHogTours
const tours = new PostHogTours({
tours: {
'feature-flag-key': {
name: 'My Feature Tour',
target: '.feature-element', // CSS selector for the element
onEligible: (element, tourId) => {
// Custom callback when tour becomes eligible
// Show your tour UI here
console.log(`Tour ${tourId} is ready to be shown`);
// Don't forget to mark the tour as seen when completed
tours.markTourAsSeen(tourId);
}
}
},
defaultOnEligible: (element, tourId) => {
// Default handler for all tours
console.log(`Default handler for tour ${tourId}`);
},
userPropertyPrefix: 'seen_tour_' // Prefix for PostHog user properties
});
*/