guideai-app 0.5.4-3 → 0.5.4-8

package/README.md

@@ -45,6 +45,7 @@ function App() {
 | `React`                           | `React`    | Yes                  | React instance from your application                                                                                                                                                |
 | `ReactDOM`                        | `ReactDOM` | Yes                  | ReactDOM instance from your application                                                                                                                                             |
 | `position`                        | `object`   | No                   | CSS positioning for the component (see below)                                                                                                                                       |
+| `launcher`                        | `object`   | No                   | Launcher presentation: floating mic circle (default) or a draggable side tab (see below)                                                                                            |
 | `environment`                     | `string`   | No                   | API environment: `'production'` (default), `'development'`, or `'local'`                                                                                                            |
 | `transcript`                      | `object`   | No                   | Transcript panel configuration (see below)                                                                                                                                          |
 | `input`                           | `object`   | No                   | Text/voice input configuration (see below)                                                                                                                                          |
@@ -187,6 +188,46 @@ position?: {
 />
 ```
 
+## Launcher Object
+
+The `launcher` prop selects how the idle Guide AI control is presented:
+
+```typescript
+launcher?: {
+  variant?: 'mic' | 'tab'; // 'mic' (default): floating circle. 'tab': edge-docked side tab.
+  side?: 'left' | 'right'; // Tab variant only — screen edge to dock to (default: 'right')
+}
+```
+
+The tab behaves exactly like the mic circle (click to start/end a conversation, same status
+colors and idle prompt animations), but it sits flush against the screen edge and can be
+**dragged up and down** that edge. The dragged offset is persisted in `localStorage` per
+conversation key, so the tab stays where the user left it. With `variant: 'tab'`, the CSS
+placement properties of `position` are ignored (`position.zIndex` still applies), and the
+transcript defaults to opening on the same side as the tab.
+
+**Right-edge tab:**
+
+```jsx
+<GuideAI
+	authKey="your-access-key"
+	React={React}
+	ReactDOM={ReactDOM}
+	launcher={{ variant: 'tab' }}
+/>
+```
+
+**Left-edge tab:**
+
+```jsx
+<GuideAI
+	authKey="your-access-key"
+	React={React}
+	ReactDOM={ReactDOM}
+	launcher={{ variant: 'tab', side: 'left' }}
+/>
+```
+
 ## Transcript Object
 
 The `transcript` prop controls the conversation transcript panel: