@franklinhelp/sdk-website
v0.1.0-alpha.22
Published
Lightweight embeddable website assistant widget for marketing sites
Downloads
89
Maintainers
Readme
@franklin/sdk-website
Lightweight embeddable website assistant widget for marketing sites. This package provides a minimal, no-dependency JavaScript widget that can be embedded on any website via a simple script tag.
Features
- 🔌 Zero dependencies - Pure JavaScript, no React or framework required
- 🎯 Tiny bundle - Optimized for minimal page load impact
- 🔒 Shadow DOM - CSS isolation to prevent conflicts
- 🍪 Visitor tracking - Automatic anonymous visitor ID management
- 💬 AI chat - Real-time chat interface
- 📝 Lead capture - Integrated lead capture forms
Installation
Via npm CDN (Recommended)
Add the script tag to your website using unpkg or jsDelivr:
<!-- Using unpkg -->
<script
src="https://unpkg.com/@franklinhelp/sdk-website@latest/dist/index.global.js"
data-franklin-site-key="YOUR_SITE_KEY"
data-franklin-assistant-id="YOUR_ASSISTANT_ID"
async
></script>
<!-- Or using jsDelivr -->
<script
src="https://cdn.jsdelivr.net/npm/@franklinhelp/sdk-website@latest/dist/index.global.js"
data-franklin-site-key="YOUR_SITE_KEY"
data-franklin-assistant-id="YOUR_ASSISTANT_ID"
async
></script>Note: Replace @latest with a specific version (e.g., @0.1.0) for production use.
Via npm (for bundlers)
npm install @franklinhelp/sdk-website
# or
pnpm add @franklinhelp/sdk-websiteThen import in your code:
import '@franklinhelp/sdk-website';Development
pnpm dev # Watch mode
pnpm build # Production build