تست برای نمایش پیامها بر روی یک پوشش (Overlay) به منظور اطلاعرسانی وضعیت سیستم به کاربران استفاده میشود.
type اعلان، آیکون و رنگهای متناظر را نشان میدهد. نوع میتواند 'info'، 'warning'، 'error' یا 'success' باشد.closable، آیکون بستن در اعلان نمایش داده میشود.duration برای اعلان مدت زمان باز بودن را مشخص میکند. اگر مقدار duration برابر 0 باشد، تست هرگز بسته نخواهد شد.toast.push() یک شناسه (UID) برای نمونه اعلان بازگشتی میدهد. میتوان این شناسه را به متد toast.remove(uid) پاس داد تا اعلان مربوطه حذف شود.| متد | توضیحات |
|---|---|
toast.push(message: ReactNode, options?: ToastProps): string | متدی برای نمایش پیام توست، که UID پیام توست فعلی را باز میگرداند |
toast.remove(key: string): void | متدی برای حذف پیام توست خاص با استفاده از کلید متد push |
toast.removeAll(): void | متدی برای حذف تمام پیامهای توست |
| پراپ | توضیحات | نوع | پیشفرض |
|---|---|---|---|
| block | آیا توست باید در عرض کامل نمایش داده شود؟ | boolean | false |
| offsetX | افزایش X توست | number | 30 |
| offsetY | افزایش Y توست | number | 30 |
| placement | محل نمایش توست | 'top-start' | 'top-center' | 'top-end' | 'bottom-start' | 'bottom-center' | 'bottom-end' | 'top-end' |
| transitionType | نوع انتقال انیمیشن | 'scale' | 'fade' | 'scale' |
| ویژگی | توضیحات | نوع | پیشفرض |
|---|---|---|---|
| closable | نمایش یا عدم نمایش آیکون بستن | boolean | false |
| customIcon | عنصر سفارشی کنار محتوای اعلان | ReactNode | string | - |
| duration | مدت زمان (به ثانیه) قبل از بسته شدن اعلان. اگر مقدار duration برابر 0 باشد، هرگز بسته نخواهد شد. | number | 3000 |
| onClose | کالبک زمانی که اعلان بسته میشود | (e: MouseEvent) => void | - |
| title | عنوان اعلان | string | - |
| type | نوع اعلان | 'info' | 'warning' | 'success' | 'danger' | - |
| width | عرض اعلان | number | string | 350 |