دیگ

Toastv1.0.1

اعلان کوتاهی که گوشهٔ صفحه ظاهر می‌شود و خودش می‌رود؛ برای تأیید یک عمل، گزارش خطا یا دادن فرصت «بازگرداندن». یک Toaster در ریشهٔ اپ بگذارید و بعد هرجا لازم شد toast() را صدا بزنید.

ری‌اکت ۱۹ و 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/toast.json
pnpm dlx digdesign@latest add https://docs.digdesign.ir/r/toast.json
yarn dlx digdesign@latest add https://docs.digdesign.ir/r/toast.json
bunx --bun digdesign@latest add https://docs.digdesign.ir/r/toast.json

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

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

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

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

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

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

استفاده

// ۱) یک بار در ریشهٔ اپ (app/layout.tsx)
import { Toaster } from "@/components/ui/toast"

<body>
  {children}
  <Toaster />
</body>

// ۲) هرجا لازم شد
"use client"
import { toast } from "@/components/ui/toast"

toast.success("تغییرات ذخیره شد.")

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

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

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

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

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

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

ترکیب اجزا

Toaster یک فروشگاه سبک بیرون از درخت React نگه می‌دارد؛ toast() هرجا صدا زده شود همان فروشگاه را به‌روزرسانی می‌کند و Toaster با useSyncExternalStore گوش می‌دهد، پس نیازی به Context یا هیچ Providerِ اضافه‌ای نیست.

جهت پیش‌فرض rtl و موقعیت پیش‌فرض «پایین چپ» است، چون در چیدمان راست‌به‌چپ گوشهٔ پایانی صفحه سمت چپ است.

رنگ‌ها از توکن‌های دیگ (popover، destructive، success) خوانده می‌شوند تا اعلان با بقیهٔ رابط یکی باشد؛ تم روشن و تیره هم از next-themes می‌آید.

خود toast یک تابع است، نه کامپوننت، پس فقط در فایل‌های کلاینتی صدا زده می‌شود.

دسترس‌پذیری

  • هر اعلان با نقش status (و alert برای خطا) ساخته می‌شود تا متن تازه به صفحه‌خوان اعلام شود، بدون اینکه فوکوس را بدزدد.
  • برای اعلانی که دکمهٔ اقدام دارد مدت را بلندتر بگذارید یا duration: Infinity بدهید؛ کاربر صفحه‌کلید باید فرصت رسیدن به دکمه را داشته باشد.
  • پیام خطای مهم را فقط با توست نگویید؛ خطای فرم باید کنار خود فیلد هم دیده شود.
  • اعلان‌ها را کوتاه بنویسید؛ متن بلند در چند ثانیه خوانده نمی‌شود.
  • Toaster را یک بار و در ریشه بگذارید؛ چند Toaster یعنی چند ناحیهٔ اعلام و پیام‌های تکراری برای صفحه‌خوان.

مرجع API

Toaster

ویژگینوعپیش‌فرضتوضیح
position"top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right""bottom-left"گوشهٔ نمایش. پیش‌فرض برای راست‌به‌چپ پایین چپ است.
dir"rtl" | "ltr""rtl"جهت متن اعلان‌ها.
theme"light" | "dark" | "system"—از next-themes خوانده می‌شود؛ معمولاً دست نزنید.
richColorsbooleanfalseرنگ پررنگ‌تر برای حالت‌های موفق و خطا؛ با توکن‌های دیگ هم کار می‌کند.
closeButtonbooleanfalseافزودن دکمهٔ بستن به هر اعلان.

toast()

ویژگینوعپیش‌فرضتوضیح
toast(message, options)(message: ReactNode, options?) => string | number—اعلان ساده؛ شناسهٔ اعلان را برمی‌گرداند.
toast.success / error / warning / info(message, options?)—همان اعلان با آیکون و رنگ حالت.
toast.promise(promise, { loading, success, error })—اعلانی که با نتیجهٔ Promise به‌روزرسانی می‌شود.
toast.dismiss(id?: string | number) => void—بستن یک اعلان یا همهٔ اعلان‌ها.
options.durationnumber4000مدت ماندن بر حسب میلی‌ثانیه؛ Infinity یعنی تا بسته شدن دستی.
options.action{ label: string; onClick: () => void }—دکمهٔ اقدام داخل اعلان.

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

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

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

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

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

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