@skippr/live-agent-sdk 0.108.0 → 0.110.0

package/README.md

@@ -232,30 +232,13 @@ function App() {
 
 ### Splash screen
 
-When your workspace selects the `Template` launcher style under Appearance, the SDK shows a pre-session card instead of the launcher bubble: what the agent can do, the microphone and screen-access rows it needs, and a Start / Continue button. Script-tag embeds get it automatically. In React, drop `<SplashOverlay>` anywhere inside `<LiveAgent>`:
+When your workspace turns the splash on under Appearance, the SDK shows a pre-session card before the session starts: what the agent can do, the microphone and screen-access rows it needs, and a Start / Continue button. It is independent of the launcher style, so you can run both or turn the launcher off and let the card be the entry point.
 
-```tsx
-import { LiveAgent, SplashOverlay } from '@skippr/live-agent-sdk';
-
-function App() {
-  return (
-    <LiveAgent appKey="pk_live_your_key">
-      <SplashOverlay />
-    </LiveAgent>
-  );
-}
-```
-
-It centres the card over a backdrop and handles its own dismissal, so there is nothing to wire up, and it renders nothing when your workspace has the splash turned off, so it is safe to leave in place either way.
-
-| Prop | Type | Description |
-|------|------|-------------|
-| `width` | `number` | Card width in px, overriding the width configured for your workspace. Clamped to the supported range. |
-| `maxHeight` | `number` | Card height as a percentage of the viewport height, overriding the configured value. Also clamped. |
+There is nothing for you to place. Every embed gets the card — script tag and React alike — and your workspace also chooses where it appears: centred over the page on its own backdrop, or inside the chat panel. The SDK renders it either way and handles its own dismissal.
 
 #### Placing the card yourself
 
-Use `<SplashScreen>` instead when you want the card inline in your own layout — a sidebar, a grid cell, a panel, rather than centred over the page. In exchange for the placement control, you own the surrounding state:
+Use `<SplashScreen>` when you also want the card inline in your own layout — a sidebar, a grid cell, a panel, rather than centred over the page. In exchange for the placement control, you own the surrounding state:
 
 ```tsx
 import { useState } from 'react';
@@ -283,14 +266,16 @@ function App() {
 
 - **You own unmounting.** `<SplashScreen>` renders nothing once it no longer applies — the user dismissed it, a session is running, or your workspace has the splash turned off — but it stays mounted until you remove it.
 - **Conditionally render your own wrapper too.** A styled slot (padding, border, grid cell) survives as an empty box when the card stops rendering, as in the example above.
+- **It follows the workspace placement.** `<SplashScreen>` renders while your workspace shows the splash over the page. When the workspace moves the splash into the chat panel, the panel renders the card and `<SplashScreen>` renders nothing.
+- **It only shows while the widget is closed.** The splash and the open widget panel never share the screen, so `<SplashScreen>` renders nothing once the user opens the panel and returns when they close it again.
 
 #### Behaviour of both
 
-- **Render exactly one.** Each instance keeps its own microphone and screen state; the SDK warns in the console when a second one mounts, or when the splash is enabled and neither component is placed.
+- **Dismissal is shared.** Closing or skipping either card dismisses the splash for the page load, so the SDK's own card and any `<SplashScreen>` you place come and go together.
 - **Session start needs no callback.** `useLiveAgent()` already reports `isStarting` / `isConnected`, so read the session from there rather than mirroring it into your own state.
-- **Bring it back after a skip.** Dismissal lasts for the page load, so the card returns on the next navigation. On a single-page app, call `reopenSplash()` from `useLiveAgent()` — wire it to a "Start guided tour" link or a help-menu item. Skipping never reveals a launcher bubble; the host owns when the card comes back.
+- **Bring it back after a skip.** Dismissal lasts for the page load, so the card returns on the next navigation. On a single-page app, call `reopenSplash()` from `useLiveAgent()` — wire it to a "Start guided tour" link or a help-menu item. Skipping never reveals a launcher that your workspace has turned off; the host owns when the card comes back.
 - **Check the config before you build around it.** `useLiveAgent()` exposes `isSplashConfigured` so you can pick between the splash and your own launcher; it reflects the workspace setting only, not whether the card is on screen right now.
-- **The card adapts to the agent.** When your workspace's default agent is an always-on expert, both components render a tips layout instead of the guided-tour one: contextual suggestions for the current page, each starting a session on click, plus a catch-all CTA. No prop switches this — it follows the agent configuration.
+- **The card adapts to the agent.** When your workspace's default agent is an always-on expert, the card renders a tips layout instead of the guided-tour one: contextual suggestions for the current page, each starting a session on click, plus a catch-all CTA. No prop switches this — it follows the agent configuration.
 
 ## API Reference
 
@@ -340,7 +325,7 @@ Hook for accessing session state and panel controls. Must be called within `<Liv
 | `activeModule` | `Module \| null` | The module the current session was started with |
 | `isLoadingModules` | `boolean` | Whether the picker list is being fetched |
 | `modulesError` | `string \| null` | Error from fetching the picker list, if any |
-| `isSplashConfigured` | `boolean` | Whether your workspace uses the `Template` launcher style, which turns the splash screen on. Configuration only — it does not tell you whether the splash is currently on screen |
+| `isSplashConfigured` | `boolean` | Whether your workspace has the splash screen turned on. Configuration only — it does not tell you whether the splash is currently on screen |
 
 ```ts
 interface Module {
@@ -396,6 +381,7 @@ Available on `window.Skippr` when using the script tag bundle.
 | Method | Description |
 |--------|-------------|
 | `Skippr.initialize(config)` | Mount the widget. Accepts `appKey` (required), `agentId` (optional — omit for picker), `getUserToken`, `userToken`, `variant`, `minimizable`, `captureMode`. |
+| `Skippr.open()` | Surface the widget from your own button. Brings back a skipped splash screen, opens the chat panel when the splash lives in it, and otherwise reveals the voice bar. The only entry point when your workspace has the launcher turned off |
 | `Skippr.logout()` | Revoke the current session server-side, clear stored auth tokens, and show the login form (direct auth mode) |
 | `Skippr.destroy()` | Remove the widget from the page and clear auth tokens |