Skip to content

@vowel.to/client v0.3.3-beta


@vowel.to/client / react / VowelProvider

Function: VowelProvider() ​

ts
function VowelProvider(__namedParameters): Element;

Defined in: lib/vowel/components/VowelProviderSimple.tsx:229

Provider component for Vowel voice agent Wrap your app with this to enable voice interactions

This is the ONLY provider users need to manage. Floating cursor is enabled by default and automatically wrapped.

Parameters ​

ParameterType
__namedParametersVowelProviderProps

Returns ​

Element

Examples ​

tsx
import { VowelProvider, VowelAgent } from '@vowel.to/client/react';
import { vowel } from './vowel.client';

function App() {
  return (
    <VowelProvider client={vowel}>
      <VowelAgent />
    </VowelProvider>
  );
}
tsx
<VowelProvider client={vowel} floatingCursor={false}>
  <VowelAgent />
</VowelProvider>
tsx
<VowelProvider 
  client={vowel}
  floatingCursor={{ 
    enabled: true,
    appearance: { cursorColor: '#2563eb' }
  }}
>
  <VowelAgent />
</VowelProvider>