@vowel.to/client / index / VowelAgentProps
Interface: VowelAgentProps
Defined in: lib/vowel/components/VowelAgent.tsx:39
Props for VowelAgent
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
position? | VowelPosition | Position of the floating button | lib/vowel/components/VowelAgent.tsx:41 |
className? | string | Custom className | lib/vowel/components/VowelAgent.tsx:44 |
showTranscripts? | boolean | Show transcript panel | lib/vowel/components/VowelAgent.tsx:47 |
buttonColor? | string | Custom button color | lib/vowel/components/VowelAgent.tsx:50 |
enableNag? | boolean | Enable the voice nag wrapper | lib/vowel/components/VowelAgent.tsx:54 |
nagTitle? | string | Custom title for the nag message | lib/vowel/components/VowelAgent.tsx:57 |
nagDescription? | string | Custom description for the nag message | lib/vowel/components/VowelAgent.tsx:60 |
nagButtonText? | string | Custom acknowledge button text for nag | lib/vowel/components/VowelAgent.tsx:63 |
nagStorageKeyPrefix? | string | LocalStorage key prefix for nag state | lib/vowel/components/VowelAgent.tsx:66 |
onNagDismiss? | () => void | Callback when nag is dismissed | lib/vowel/components/VowelAgent.tsx:69 |
enableTermsModal? | boolean | Enable the terms and privacy modal | lib/vowel/components/VowelAgent.tsx:73 |
termsModalTitle? | string | Modal title for terms/privacy | lib/vowel/components/VowelAgent.tsx:76 |
termsModalDescription? | string | Modal description for terms/privacy | lib/vowel/components/VowelAgent.tsx:79 |
termsContent? | string | Terms of service content (HTML or text) | lib/vowel/components/VowelAgent.tsx:82 |
termsUrl? | string | URL to external terms of service | lib/vowel/components/VowelAgent.tsx:85 |
privacyContent? | string | Privacy policy content (HTML or text) | lib/vowel/components/VowelAgent.tsx:88 |
privacyUrl? | string | URL to external privacy policy | lib/vowel/components/VowelAgent.tsx:91 |
termsAcceptButtonText? | string | Text for the accept button in modal | lib/vowel/components/VowelAgent.tsx:94 |
termsDeclineButtonText? | string | Text for the decline button in modal | lib/vowel/components/VowelAgent.tsx:97 |
termsAllowDecline? | boolean | Whether to show a decline button in modal | lib/vowel/components/VowelAgent.tsx:100 |
termsStorageKeyPrefix? | string | LocalStorage key prefix for terms acceptance state | lib/vowel/components/VowelAgent.tsx:103 |
onTermsAccept? | () => void | Callback when terms are accepted | lib/vowel/components/VowelAgent.tsx:106 |
onTermsDecline? | () => void | Callback when terms are declined | lib/vowel/components/VowelAgent.tsx:109 |
enableFloatingCursor? | boolean | Whether to render the floating cursor Only applies when VowelProvider has floatingCursor enabled Default true Set to false if you want to render the cursor separately: Example <VowelProvider client={client}> <VowelAgent enableFloatingCursor={false} /> <FloatingCursorRenderer /> </VowelProvider> | lib/vowel/components/VowelAgent.tsx:126 |