JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 176
  • Score
    100M100P100Q73795F
  • License MIT

The simplest way to add voice UI to your React app. One install, one component, works with Vapi and ElevenLabs out of the box.

Package Exports

  • orb-ui
  • orb-ui/adapters

Readme

orb-ui

The simplest way to add voice UI to your React app. One install, one component, works with Vapi and ElevenLabs out of the box.

orb-ui demo

Live Demo · npm · GitHub 

import { Orb } from 'orb-ui'
import { createVapiAdapter } from 'orb-ui/adapters'

<Orb adapter={createVapiAdapter(vapi, { assistantId: 'your-id' })} theme="circle" />

Install

npm install orb-ui

Note: Orb uses React hooks internally — in Next.js App Router, use it in a 'use client' component.

Quick Start

With Vapi

import Vapi from '@vapi-ai/web'
import { Orb } from 'orb-ui'
import { createVapiAdapter } from 'orb-ui/adapters'

const vapi = new Vapi('your-public-key')
const adapter = createVapiAdapter(vapi, { assistantId: 'your-assistant-id' })

function App() {
  return <Orb adapter={adapter} theme="circle" />
}

With ElevenLabs

import { Conversation } from '@elevenlabs/client'
import { Orb } from 'orb-ui'
import { createElevenLabsAdapter } from 'orb-ui/adapters'

const adapter = createElevenLabsAdapter(Conversation, { agentId: 'your-agent-id' })

function App() {
  return <Orb adapter={adapter} theme="circle" />
}

Controlled mode (custom integration)

import { Orb } from 'orb-ui'
import { useState } from 'react'

function App() {
  const [state, setState] = useState('idle')
  const [volume, setVolume] = useState(0)

  return <Orb state={state} volume={volume} theme="circle" />
}

Themes

Theme Description
debug State + volume display with start/stop. Use to verify your integration works.
circle Pulsing circle that reacts to volume.
bars Five bars that animate with voice.

Props

Prop Type Default Description
theme 'debug' | 'circle' | 'bars' 'debug' Visual theme
state OrbState 'idle' Conversation state (controlled mode)
volume number 0 Audio volume, 0–1 (controlled mode)
adapter OrbAdapter — Provider adapter (manages state + volume automatically)
size number 200 Size in pixels
onStart () => void — Custom start handler (overrides adapter.start())
onStop () => void — Custom stop handler (overrides adapter.stop())

States

idle · connecting · listening · speaking · error

Supported Providers

Provider Adapter
Vapi createVapiAdapter from orb-ui/adapters
ElevenLabs createElevenLabsAdapter from orb-ui/adapters
Custom Use controlled mode — pass state and volume directly

Development

git clone https://github.com/alexanderqchen/orb-ui.git
cd orb-ui
npm install
cd demo && npm install && cd ..

# Build the library
npm run build

# Run demo locally
cd demo && npm run dev

License

MIT © Alexander Chen