@skippr/live-agent-sdk 0.24.0 → 0.25.0

package/README.md

@@ -157,7 +157,6 @@ Any component rendered inside `<LiveAgent>` can use the `useLiveAgent` hook to a
 ```tsx
 import { LiveAgent, useLiveAgent } from '@skippr/live-agent-sdk';
 
-function ConnectionStatus() {
 function ConnectionStatus() {
   const { isConnected } = useLiveAgent();
 
@@ -192,6 +191,9 @@ Self-contained widget component. Renders a floating button that opens a sidebar
 | `minimizable` | `boolean` | `true` | Whether the widget can be minimized |
 | `defaultOpen` | `boolean` | `false` | Whether the panel starts open |
 | `welcomeMessage` | `string` | — | Message shown on the minimized bubble |
+| `startSessionLabel` | `string` | `'Talk to Skippr'` | Label for the start-session button |
+| `autoFocusChat` | `boolean` | `true` | Whether the chat input auto-focuses when opened |
+| `showObservingBanner` | `boolean` | `true` | Whether to show the "Skippr is observing this page" banner during screen share |
 
 ### `useLiveAgent()`
 
@@ -223,6 +225,23 @@ Hook for accessing session state and panel controls. Must be called within `<Liv
 | `minimizePanel` | `() => void` | Minimize the widget |
 | `setPosition` | `(position: 'left' \| 'right') => void` | Change widget position |
 
+### Additional Hooks
+
+All hooks must be called within `<LiveAgent>`.
+
+| Hook | Returns | Description |
+|------|---------|-------------|
+| `useMediaControls()` | `{ isMuted, isScreenSharing, toggleMute, toggleScreenShare }` | Mic and screen share state and toggles |
+| `useAgentVoiceState()` | `{ isSpeaking, isThinking }` | Agent voice activity state |
+| `useIsLocalSpeaking()` | `boolean` | Whether the local user is currently speaking |
+| `useElapsedSeconds(isRunning)` | `number` | Drift-safe elapsed seconds since the flag flipped to `true` |
+
+### Utilities
+
+| Export | Signature | Description |
+|--------|-----------|-------------|
+| `formatTime` | `(seconds: number) => string` | Format seconds as `mm:ss` |
+
 ### Global API (Script Tag)
 
 Available on `window.Skippr` when using the script tag bundle.