@tavus/embed 0.3.0 → 0.5.0

package/README.md

@@ -34,10 +34,11 @@ Importing the package registers the `<tavus-embed>` custom element as a side eff
 
 ## 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.               |
+| 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.               |
+| `layout`          | `"inline" \| "full-screen"` | Where the preview copy sits. Defaults to `inline`. See [Layout](#layout).       |
 
 ## Sizing
 
@@ -49,6 +50,19 @@ Importing the package registers the `<tavus-embed>` custom element as a side eff
 </div>
 ```
 
+## Layout
+
+`layout` only changes how the preview screen arranges its copy — sizing stays entirely yours (the element always fills its parent, in either mode).
+
+- `inline` (default): the greeting and the start button share a bar along the bottom edge. Below a container width of `56.25rem` the greeting moves up to the top corner, since the bar has no room for both.
+- `full-screen`: the greeting always sits in the top-left corner and the start button is centered above the lower edge, clear of the replica's face. Meant for a section that gives the embed the whole viewport; the in-call fullscreen toggle is dropped, since the page is already the app.
+
+```html
+<section style="height: 100dvh;">
+  <tavus-embed deployment-id="YOUR_DEPLOYMENT_ID" layout="full-screen"></tavus-embed>
+</section>
+```
+
 ## License
 
 MIT

package/dist/index.d.ts

@@ -1,6 +1,12 @@
 export { TavusIntegration, TAVUS_EVENT_NAMES } from './integration.ts';
 export type { TavusEventName, TavusEventMap, TavusInteraction } from './integration.ts';
 interface TavusEmbedAttributes {
+    /**
+     * Where the preview screen puts its copy. `"full-screen"` pins it to the
+     * top-left corner with the action above the lower edge; anything else keeps
+     * the bottom bar. Arrangement only — sizing is always the host page's.
+     */
+    layout?: "inline" | "full-screen";
     /** Deployment to load. Resolved via the `/init` fetch. */
     "deployment-id"?: string;
     /** JSON `OverrideConfig`, deep-merged on top of the fetched config. */
@@ -13,6 +19,12 @@ interface TavusEmbedAttributes {
     "memory-stores"?: string;
     /** API base origin override (defaults to the production API). */
     "base-url"?: string;
+    /**
+     * @experimental Undocumented JSON escape hatch for tuning the expanded card
+     * (`enabled`, `aspect`, `custom_aspect`, `max_width`, `max_height`). Not part
+     * of the supported surface — it may change or disappear without notice.
+     */
+    "expand-options"?: string;
     /** Preview/auth token forwarded to `/init` and `/start`. */
     token?: string;
 }