Skip to content

@vowel.to/client v0.1.2-393


@vowel.to/client / index / useVowel

Function: useVowel()

ts
function useVowel(): VowelContextType;

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

Hook to access Vowel context

Returns

VowelContextType

Example

tsx
function MyComponent() {
  const { state, toggleSession, client } = useVowel();
  
  // Don't render if client is not available yet
  if (!client) {
    return null;
  }
  
  return (
    <button onClick={toggleSession}>
      {state.isConnected ? 'Stop' : 'Start'} Voice
    </button>
  );
}