Open in
React جزو
ThunderPhone وائس ویجیٹ کو React ایپلیکیشن میں شامل کریں
ThunderPhoneWidget کمپوننٹ ایک گلاس مورفک کال بار رینڈر کرتا ہے جس میں خاموش کرنے، کال ختم کرنے، اور کنکشن کی حیثیت دکھانے کے لیے بلٹ اِن کنٹرولز شامل ہیں۔ React ایپ میں وائس AI شامل کرنے کا یہ تیز ترین طریقہ ہے۔
انسٹالیشن
npm install @thunderphone/widgetبنیادی استعمال
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
/>
)
}پراپس
کمپوننٹ ThunderPhoneWidgetProps کے ذریعے درج ذیل پراپس قبول کرتا ہے:
| پراپ | قسم | ضروری | طے شدہ | وضاحت |
|---|---|---|---|---|
publishableKey | string | ہاں | -- | ڈیش بورڈ میں ویب ویجٹس سے قابلِ اشاعت API کلید (pk_live_...)۔ ایجنٹ کلید کی ویجٹ کنفیگریشن سے خودکار طور پر متعین ہوتا ہے۔ |
theme | 'light' | 'dark' | نہیں | 'light' | رنگوں کی اسکیم۔ ویجٹ روٹ پر tp--light یا tp--dark کلاس لاگو کرتا ہے۔ |
primaryColor | string | نہیں | '#000000' (لائٹ) / '#ffffff' (ڈارک) | CSS رنگ اسٹرنگ جو نمایاں رنگ کے طور پر استعمال ہوتی ہے (کال بٹن، ویوفارم، فعال اشاریے)۔ |
title | string | نہیں | 'Voice assistant' | ویجٹ بار میں دکھایا جانے والا متن۔ |
position | 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' | نہیں | 'bottom-right' | ویجٹ کے لیے ویوپورٹ کی مقررہ پوزیشن۔ |
apiBase | string | نہیں | 'https://api.thunderphone.com/v1' | API بیس URL اووررائیڈ۔ |
language | string | نہیں | -- | فی سیشن زبان اووررائیڈ -- زبان کا کوڈ یا لوکیل، جیسے en، es، یا fr-FR۔ متعین نہ ہونے پر، ایجنٹ کی کنفیگر کردہ زبان لاگو ہوتی ہے۔ کلید کے براؤزر اووررائیڈز کے تحت language درکار ہے۔ |
voice | string | نہیں | -- | فی سیشن آواز اووررائیڈ -- آواز کا نام، جیسے maria۔ متعین نہ ہونے پر، ایجنٹ کی کنفیگر کردہ آواز لاگو ہوتی ہے۔ کلید کے براؤزر اووررائیڈز کے تحت voice درکار ہے۔ |
context | string | نہیں | -- | فی سیشن حقائق پر مبنی صفحہ یا سائٹ کا سیاق جو ایجنٹ کو منتقل کیا جاتا ہے (مثلاً، اس صفحے کی تفصیلات جسے وزیٹر دیکھ رہا ہے)۔ سرور کی طرف سے 12,000 حروف تک محدود کیا جاتا ہے۔ کلید کے براؤزر اووررائیڈز کے تحت context درکار ہے۔ |
onConnect | () => void | نہیں | -- | وائس سیشن کے کامیابی سے منسلک ہونے پر کال کیا جاتا ہے۔ |
onDisconnect | () => void | نہیں | -- | سیشن ختم ہونے پر کال کیا جاتا ہے۔ |
onError | (error) => void | نہیں | -- | خرابیوں پر کال کیا جاتا ہے۔ error آبجیکٹ میں error (کوڈ) اور message فیلڈز ہوتے ہیں۔ |
className | string | نہیں | -- | ویجٹ کنٹینر پر لاگو کیا جانے والا اضافی CSS کلاس نام۔ |
ringtone | boolean | string | نہیں | false | کنیکٹ ہونے کے دوران رنگ ٹون چلائیں۔ طے شدہ رنگ ٹون کے لیے true، یا حسب ضرورت آڈیو کے لیے URL اسٹرنگ۔ |
مثالیں
حسب ضرورت رنگ کے ساتھ ڈارک تھیم
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
theme="dark"
primaryColor="#8b5cf6"
title="Talk to our AI"
/>
)
}حسب ضرورت پوزیشن
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
position="bottom-left"
/>
)
}فی سیشن زبان، آواز، اور سیاق
جب کال شروع ہوتی ہے تو language، voice، اور context props کو سیشن درخواست (POST /widget/session) میں بھیج دیا جاتا ہے، جو اس سیشن کے لیے ایجنٹ کی ترتیب شدہ ڈیفالٹ سیٹنگز کو اوور رائیڈ کر دیتے ہیں۔ ڈیش بورڈ میں widget کے لیے براؤزر اوور رائیڈز کے تحت (یا key کے allowed_overrides میں) ہر استعمال ہونے والے prop کو فعال کریں۔ نئے widgets کسی کو قبول نہیں کرتے، اور ایسا سیشن ریکویسٹ جس میں کوئی غیر فعال prop شامل ہو، 400 override_not_allowed کے ساتھ ناکام ہو جاتا ہے؛ براؤزر اوور رائیڈز دیکھیں۔
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function PricingPageWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
language="es"
voice="maria"
context="Page: Pricing. Plans: Starter $29/mo, Pro $99/mo. Annual billing saves 20%."
/>
)
}وزیٹر جس صفحے پر موجود ہے، اس کے بارے میں ایجنٹ کو حقائق پر مبنی معلومات دینے کے لیے context استعمال کریں -- مثلاً پروڈکٹ کی تفصیلات، قیمتیں، یا صفحہ مخصوص FAQs۔ ایجنٹ اسے ہدایات کے طور پر نہیں بلکہ صفحے کے مواد کے طور پر سمجھتا ہے۔ اسے سرور کی جانب سے 12,000 حروف تک محدود کر دیا جاتا ہے۔
ایونٹ کال بیکس کے ساتھ
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function SupportWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
onConnect={() => {
console.log('Voice session connected')
analytics.track('widget_call_started')
}}
onDisconnect={() => {
console.log('Voice session ended')
analytics.track('widget_call_ended')
}}
onError={(error) => {
console.error(`Widget error: ${error.error} - ${error.message}`)
}}
/>
)
}حسب ضرورت اسٹائلنگ کے ساتھ
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function BrandedWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
primaryColor="#4a90d9"
className="my-custom-widget"
/>
)
}.my-custom-widget .tp-button--end {
background-color: #e74c3c;
}تمام دستیاب CSS کلاسز اور حسب ضرورت خصوصیات کے لیے اسٹائلنگ گائیڈ دیکھیں۔
رنگ ٹون کے ساتھ
کنکشن قائم ہونے کے دوران فون بجنے کی آواز چلائیں:
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function PhoneWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone={true}
/>
)
}آڈیو فائل کا URL دے کر حسب ضرورت رنگ ٹون استعمال کریں:
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone="https://example.com/my-ringtone.mp3"
/>ویجیٹ کے connecting حالت میں ہونے کے دوران رنگ ٹون بار بار چلتی ہے، اور ایجنٹ کے کنیکٹ ہونے پر بتدریج ختم ہو جاتی ہے۔
حسب ضرورت API بیس کے ساتھ
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
apiBase="https://your-proxy.example.com/v1"
/>خرابیوں کا انتظام
جب onError کال بیک چلتا ہے، تو اسے دو فیلڈز کے ساتھ ایک ایرر آبجیکٹ ملتا ہے:
| فیلڈ | قسم | تفصیل |
|---|---|---|
error | string | مشین کے قابلِ فہم ایرر کوڈ |
message | string | انسان کے قابلِ فہم ایرر کی وضاحت |
عام ایرر کوڈز میں ڈومین کی اجازت نہ ہونا، ایجنٹ نہ ملنا، اور غلط API کلید شامل ہیں۔