Skip to content

Repository files navigation

Conversational AI Widget Embed

A lightweight TypeScript widget for embedding conversational AI functionality with all dependencies bundled for easy integration.

Overview

This package provides a simple way to integrate conversational AI widgets into web applications. It serves as a wrapper around @askbenny/convai-widget-core with all dependencies pre-bundled for convenient embedding.

Installation

npm install @askbenny/convai-widget-embed

Usage

Basic Integration

<!-- Include via CDN -->
<script src="https://unpkg.com/@askbenny/convai-widget-embed@latest/dist/index.js"></script>

ES Module

import "@askbenny/convai-widget-embed";

The widget will automatically register itself when imported or loaded.

Features

  • Zero Configuration: Works out of the box with default settings
  • Lightweight: Bundled with Vite for optimal performance
  • TypeScript Support: Written in TypeScript with full type definitions
  • CDN Ready: Available via unpkg for easy integration

Development

Prerequisites

  • Node.js 16+
  • pnpm (preferred package manager)

Setup

# Install dependencies
pnpm install

# Build the library
pnpm run build

# Run linting
pnpm run lint

Scripts

  • build - Build the library using Vite
  • lint - Run all linting checks (TypeScript, ESLint, Prettier)
  • lint:ts - TypeScript type checking
  • lint:es - ESLint code quality checks
  • lint:prettier - Prettier formatting checks

Build Output

The build process creates an IIFE (Immediately Invoked Function Expression) bundle at dist/index.js that can be easily embedded in any web page.

Repository

Part of the convai-widget-embed monorepo.

License

MIT © ElevenLabs

1.4.14 validation

This patch keeps the existing dist/index.js classic-script entrypoint and askbenny-convai element. It pins @askbenny/convai-widget-core to npm version 1.4.14, with the SDK still locked at 1.1.1 and AskBenny session acquisition preserved.

Run pnpm check-types, pnpm lint:es, pnpm build, and pnpm test. Browser checks use Playwright Chromium (pnpm exec playwright install chromium); PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH can select an installed Chromium browser. The publish workflow requires these checks to pass before releasing the package.

About

Askbenny elevenlabs widget wrapper that enables users to embed multimodal agents directly within their website

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages