@tavus/widget
v0.1.9
Published
Tavus conversational video AI <tavus-widget> launcher custom element for the web.
Downloads
2,642
Readme
@tavus/widget
Tavus experience as a launcher <tavus-widget> custom element. Drop a single tag into any page and you get a floating launcher that opens a fully working Tavus conversation in a shadow DOM — no React, no build step required.
Create and configure a deployment — and grab the embed snippet — in the Tavus PAL Maker.
Install
CDN (recommended for static pages)
<script src="https://unpkg.com/@tavus/widget@latest"></script>
<tavus-widget deployment-id="YOUR_DEPLOYMENT_ID"></tavus-widget>For a pinned version, use https://unpkg.com/@tavus/[email protected].
npm (bundler / framework apps)
npm install @tavus/widgetimport "@tavus/widget";Importing the package registers the <tavus-widget> custom element as a side effect. After that you can use the tag anywhere in your app's markup — including JSX:
<tavus-widget deployment-id="YOUR_DEPLOYMENT_ID" />Attributes
| Attribute | Type | Description |
| ----------------- | ------ | ------------------------------------------------------------------------------- |
| deployment-id | string | The Tavus deployment ID. Fetches configuration from /v2/deployments/:id/init. |
| override-config | JSON | Optional JSON object that is deep-merged over the fetched config. |
License
MIT
