Streaming Textv1.0.1

متن را حرف‌به‌حرف نشان می‌دهد تا حسِ جریانِ توکنِ مدل را بدهد. برای پیامِ واقعاً استریم‌شونده از سرور، بجای این کامپوننت مستقیم متنِ رسیده را append کنید و همین‌جا فقط با mode="static" نشانش دهید؛ StreamingText برای شبیه‌سازی و پاسخ‌های از‌پیش‌کامل است.

ری‌اکت ۱۹ و Next.js با پیاده‌سازی دسترس‌پذیری داخلی دیگویو ۳ با Composition API — هنوز برای این کامپوننت پورت نشدهSvelte ۵ با runes — هنوز برای این کامپوننت پورت نشدهانگولار با signals و دایرکتیوهای standalone — هنوز برای این کامپوننت پورت نشده

این کامپوننت فعلاً برای ۱ فریم‌ورک از ۴ فریم‌ورک آماده است.

این نمونه هنوز برای Vue پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

این نمونه هنوز برای Svelte پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

این نمونه هنوز برای Angular پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

نصب

با CLI اختصاصی digdesign کامپوننت را از رجیستری دیگ نصب کنید؛ وابستگی‌ها و فایل‌ها خودکار اضافه می‌شوند.

پکیج‌منیجر پیش‌فرض Node.jsنصب سریع با لینک سخت و دیسک مشترکYarn نسخهٔ ۲ به بالا (Berry)رانتایم و پکیج‌منیجر Bun
npx digdesign@latest add https://docs.digdesign.ir/r/streaming-text.json
pnpm dlx digdesign@latest add https://docs.digdesign.ir/r/streaming-text.json
yarn dlx digdesign@latest add https://docs.digdesign.ir/r/streaming-text.json
bunx --bun digdesign@latest add https://docs.digdesign.ir/r/streaming-text.json

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

استفاده

import { StreamingText, StreamingSources } from "@/components/ui/streaming-text"

<StreamingText text={message.text} onDone={() => scrollToBottom()} />
<StreamingSources sources={message.sources} />

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

ترکیب اجزا

هوکِ useStreamingText(text, speedMs) هم جداگانه export شده اگر بخواهید متن را داخل عنصر دیگری (نه یک div ساده) نشان دهید.

با تغییرِ text (پاسخِ تازه) نمایش از نو شروع می‌شود؛ برای پخشِ دوباره روی همان متن، یک key متفاوت به کامپوننت بدهید (نمونهٔ بالا همین کار را می‌کند).

StreamingSources کاملاً جدا از انیمیشنِ متن است؛ معمولاً با onDone نشانش می‌دهید تا قبل از تمامِ پاسخ ظاهر نشود.

دسترس‌پذیری

  • نشانگرِ چشمک‌زنِ انتها aria-hidden است؛ محتوای واقعی همان متنِ درحالِ‌نمایش است، پس صفحه‌خوان چیزِ اضافه‌ای نمی‌شنود.
  • برای کاربرانی که motion کاهش‌یافته می‌خواهند، mode="static" را بر پایهٔ prefers-reduced-motion انتخاب کنید تا متن یک‌جا نشان داده شود.

مرجع API

StreamingText

ویژگینوعپیش‌فرضتوضیح
textstring—متنِ کامل؛ حرف‌به‌حرف آشکار می‌شود.
speednumber25میلی‌ثانیه بین هر حرف.
mode"streaming" | "static""streaming"static یعنی همین حالا کامل نشان بده (تاریخچهٔ گفتگو).
onDone() => void—وقتی نمایش کامل شد صدا زده می‌شود.

StreamingSources

ویژگینوعپیش‌فرضتوضیح
sources{ title: string; url: string }[]—ردیف چیپ‌های لینک‌دار زیرِ پاسخ.

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.