Skip to content

Commit 1d26327

Browse files
stevenbdfstevenbdf
committed
Update README.md
1 parent d004cf6 commit 1d26327

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

‎README.md‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -71,42 +71,42 @@ The simplest way to add the widget to your website:
7171
7272
### Optional Props
7373

74-
| Prop | Type | Default | Description |
75-
| ------------------------- | --------------------------------------------------------------------------------- | ------------------------ | ---------------------------------- |
76-
| `mode` | `'voice' \| 'chat' \| 'hybrid'` | `'chat'` | Widget interaction mode |
77-
| `theme` | `'light' \| 'dark'` | `'light'` | Color theme |
78-
| `position` | `'bottom-right' \| 'bottom-left' \| 'top-right' \| 'top-left' \| 'bottom-center'` | `'bottom-right'` | Screen position |
79-
| `size` | `'tiny' \| 'compact' \| 'full'` | `'full'` | Widget size |
80-
| `borderRadius` | `'none' \| 'small' \| 'medium' \| 'large'` | `'medium'` | Corner radius style |
81-
| `apiUrl` | `string` | - | Custom API endpoint for chat mode |
82-
| **Colors** | | | |
83-
| `baseBgColor` | `string` | - | Main background color |
84-
| `accentColor` | `string` | `'#14B8A6'` | Primary accent color |
85-
| `ctaButtonColor` | `string` | `'#000000'` | CTA button background color |
86-
| `ctaButtonTextColor` | `string` | `'#FFFFFF'` | CTA button text/icon color |
87-
| **Text Labels** | | | |
88-
| `title` | `string` | `'Talk with AI'` | Main widget title |
89-
| `startButtonText` | `string` | `'Start'` | Voice call start button text |
90-
| `endButtonText` | `string` | `'End Call'` | Voice call end button text |
91-
| `ctaTitle` | `string` | _(uses title)_ | Floating button main text |
92-
| `ctaSubtitle` | `string` | - | Floating button subtitle text |
93-
| **Empty States** | | | |
94-
| `voiceEmptyMessage` | `string` | - | Message when voice mode is empty |
95-
| `voiceActiveEmptyMessage` | `string` | - | Message during active voice call |
96-
| `chatEmptyMessage` | `string` | - | Message when chat is empty |
97-
| `hybridEmptyMessage` | `string` | - | Message for hybrid mode |
98-
| **Chat Configuration** | | | |
99-
| `chatFirstMessage` | `string` | - | Initial assistant message in chat |
100-
| `chatPlaceholder` | `string` | `'Type your message...'` | Chat input placeholder text |
101-
| **Voice Configuration** | | | |
102-
| `voiceShowTranscript` | `boolean` | `false` | Show/hide voice transcript |
103-
| `voiceAutoReconnect` | `boolean` | `false` | Auto-reconnect to an active web call within the same browser tab (uses session storage) |
104-
| `reconnectStorageKey` | `string` | `'vapi_widget_web_call'` | Key for storing reconnection data (uses session storage) |
105-
| **Consent Configuration** | | | |
106-
| `consentRequired` | `boolean` | `false` | Show consent form before first use |
107-
| `consentTitle` | `string` | `"Terms and conditions"` | Consent form title |
108-
| `consentContent` | `string` | _(default message)_ | Terms & conditions content |
109-
| `consentStorageKey` | `string` | `"vapi_widget_consent"` | Key for storing consent |
74+
| Prop | Type | Default | Description |
75+
| ------------------------- | --------------------------------------------------------------------------------- | ------------------------ | --------------------------------------------------------------------------------------- |
76+
| `mode` | `'voice' \| 'chat' \| 'hybrid'` | `'chat'` | Widget interaction mode |
77+
| `theme` | `'light' \| 'dark'` | `'light'` | Color theme |
78+
| `position` | `'bottom-right' \| 'bottom-left' \| 'top-right' \| 'top-left' \| 'bottom-center'` | `'bottom-right'` | Screen position |
79+
| `size` | `'tiny' \| 'compact' \| 'full'` | `'full'` | Widget size |
80+
| `borderRadius` | `'none' \| 'small' \| 'medium' \| 'large'` | `'medium'` | Corner radius style |
81+
| `apiUrl` | `string` | - | Custom API endpoint for chat mode |
82+
| **Colors** | | | |
83+
| `baseBgColor` | `string` | - | Main background color |
84+
| `accentColor` | `string` | `'#14B8A6'` | Primary accent color |
85+
| `ctaButtonColor` | `string` | `'#000000'` | CTA button background color |
86+
| `ctaButtonTextColor` | `string` | `'#FFFFFF'` | CTA button text/icon color |
87+
| **Text Labels** | | | |
88+
| `title` | `string` | `'Talk with AI'` | Main widget title |
89+
| `startButtonText` | `string` | `'Start'` | Voice call start button text |
90+
| `endButtonText` | `string` | `'End Call'` | Voice call end button text |
91+
| `ctaTitle` | `string` | _(uses title)_ | Floating button main text |
92+
| `ctaSubtitle` | `string` | - | Floating button subtitle text |
93+
| **Empty States** | | | |
94+
| `voiceEmptyMessage` | `string` | - | Message when voice mode is empty |
95+
| `voiceActiveEmptyMessage` | `string` | - | Message during active voice call |
96+
| `chatEmptyMessage` | `string` | - | Message when chat is empty |
97+
| `hybridEmptyMessage` | `string` | - | Message for hybrid mode |
98+
| **Chat Configuration** | | | |
99+
| `chatFirstMessage` | `string` | - | Initial assistant message in chat |
100+
| `chatPlaceholder` | `string` | `'Type your message...'` | Chat input placeholder text |
101+
| **Voice Configuration** | | | |
102+
| `voiceShowTranscript` | `boolean` | `false` | Show/hide voice transcript |
103+
| `voiceAutoReconnect` | `boolean` | `false` | Auto-reconnect to an active web call within the same browser tab (uses session storage) |
104+
| `reconnectStorageKey` | `string` | `'vapi_widget_web_call'` | Key for storing reconnection data (uses session storage) |
105+
| **Consent Configuration** | | | |
106+
| `consentRequired` | `boolean` | `false` | Show consent form before first use |
107+
| `consentTitle` | `string` | `"Terms and conditions"` | Consent form title |
108+
| `consentContent` | `string` | _(default message)_ | Terms & conditions content |
109+
| `consentStorageKey` | `string` | `"vapi_widget_consent"` | Key for storing consent |
110110

111111
### Event Callbacks
112112

@@ -279,7 +279,7 @@ Use this approach if your environment doesn't support custom elements or for bet
279279

280280
### Voice-Only with Auto-Reconnect
281281

282-
```tsx
282+
````tsx
283283
<VapiWidget
284284
publicKey="pk_123"
285285
assistantId="asst_456"
@@ -301,7 +301,7 @@ npm install
301301
302302
# Build everything
303303
npm run build:all
304-
```
304+
````
305305
306306
### Development Commands
307307

0 commit comments

Comments
 (0)