@vowel.to/client / react / VowelProviderProps
Interface: VowelProviderProps
Defined in: lib/vowel/components/VowelProviderSimple.tsx:115
Props for VowelProvider
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
client | Vowel | null | Vowel client instance (can be null if not yet initialized) | lib/vowel/components/VowelProviderSimple.tsx:117 |
children | ReactNode | Children to render | lib/vowel/components/VowelProviderSimple.tsx:120 |
floatingCursor? | | false | FloatingCursorConfig | Optional: Floating cursor configuration for React mode When enabled, cursor will be rendered as a native React component Default { enabled: true } (enabled by default) Set to false to disable: Examples <VowelProvider client={client} floatingCursor={false}> <VowelAgent /> </VowelProvider> Or customize appearance: <VowelProvider client={client} floatingCursor={{ enabled: true, appearance: { cursorColor: '#2563eb' } }} > <VowelAgent /> </VowelProvider> | lib/vowel/components/VowelProviderSimple.tsx:150 |
clientMode? | "sticky" | "strict" | How to handle transient null clients. - sticky (default): keep the last known good client across transient nulls. - strict: immediately clear the active client when prop becomes null. | lib/vowel/components/VowelProviderSimple.tsx:158 |
nullClientGraceMs? | number | In sticky mode, how long to wait before releasing an idle client after prop=null. This timeout is ignored while a session is live (connected/connecting/resuming/disconnecting). Default 5000 | lib/vowel/components/VowelProviderSimple.tsx:167 |