@skippr/live-agent-sdk 0.81.0 → 0.83.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/esm/lib-exports.js +377 -229
- package/dist/skippr-sdk.js +121 -121
- package/dist/types/capture/pausedScreenTrack.d.ts +2 -0
- package/dist/types/hooks/useElapsedSeconds.d.ts +1 -1
- package/dist/types/hooks/useIsSessionHeld.d.ts +1 -0
- package/dist/types/hooks/useSessionHold.d.ts +3 -1
- package/dist/types/lib-exports.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -216,7 +216,7 @@ Self-contained widget component. Renders a floating button that opens a sidebar
|
|
|
216
216
|
| `welcomeMessage` | `string` | — | Message shown on the minimized bubble |
|
|
217
217
|
| `startSessionLabel` | `string` | `'Talk to Skippr'` | Label for the start-session button (only shown when `agentId` is pinned) |
|
|
218
218
|
| `autoFocusChat` | `boolean` | `true` | Whether the chat input auto-focuses when opened |
|
|
219
|
-
| `captureMode` | `'screenshare' \| 'auto'` | `'
|
|
219
|
+
| `captureMode` | `'screenshare' \| 'auto'` | `'auto'` | How the agent sees the page — `'auto'` uses DOM capture (no permission prompt), `'screenshare'` prompts the user to share |
|
|
220
220
|
| `animateAgentCursor` | `boolean` | `false` | Animate the agent's cursor as it points to elements on the page. Primarily configured per agent in the dashboard; this prop is a fallback when the agent has no preference set. |
|
|
221
221
|
|
|
222
222
|
### `useLiveAgent()`
|
|
@@ -283,6 +283,7 @@ All hooks must be called within `<LiveAgent>`.
|
|
|
283
283
|
| `useMediaControls()` | `{ isMuted, isScreenSharing, toggleMute, toggleScreenShare }` | Mic and screen share state and toggles |
|
|
284
284
|
| `useAgentVoiceState()` | `{ state, isSpeaking, isListening }` | Agent voice activity state — `state` is the full agent state (`'listening' \| 'thinking' \| 'speaking' \| ...`) |
|
|
285
285
|
| `useIsLocalSpeaking()` | `boolean` | Whether the local user is currently speaking |
|
|
286
|
+
| `useIsSessionHeld()` | `boolean` | `true` while the user has paused the live session; `false` when active or when there is no session. |
|
|
286
287
|
| `useElapsedSeconds(isRunning)` | `number` | Drift-safe elapsed seconds since the flag flipped to `true` |
|
|
287
288
|
|
|
288
289
|
### Utilities
|