Toast
תור של הודעות קצרות מועד.
- דפדפנים
- Chrome 114+Firefox 125+Safari 17+
- שכבה
- 1
- גודל חבילה דחוסה
- 2.87 kB
- מגבלת פריסה כפויה
- 0 ms
- מגבלת Axe
- 0
- תואם SSR
- כן
- חוזה מפורסם
- סביבת בדיקות
מגרש ניסויים
API
Toast.Provider
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
limit | number | 3 | המספר המרבי של הודעות זמניות הנשמרות בתור; הישנות יותר מוסרות. |
slotProps | ToastProviderSlotProps | — | מאפיינים לאלמנטים של האזורים החיים המנומסים והנחרצים. |
children | ReactNode | — | העץ שיכול לקרוא ל-useToast ולהציג אזור תצוגה. |
Toast.Viewport
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
aria-label | string | — | שם נגיש לאזור המכיל את ההודעות הזמניות שבתור. |
className | string | — | המחלקה המוחלת על אלמנט אזור התצוגה. |
popover | "manual" | — | מוגדר על ידי אזור התצוגה החי בצד הלקוח כדי שהתור המוצג יהיה בשכבה העליונה; מעטפת השרת משאירה אותו ללא ערך. |
ref | Ref<HTMLElement> | — | ref לאלמנט אזור התצוגה. |
slotProps | ToastViewportSlotProps | — | מאפיינים לכרטיסי הודעות זמניות ולתוכן שהם יוצרים; ניתן למקד משבצות חוזרות לפי מזהה הודעה. |
children | ReactNode | — | תוכן נוסף המוצג בתוך אזור התצוגה לצד ההודעות הזמניות שבתור. |
Toast.Root
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
className | string | — | המחלקה המוחלת על כרטיס ההודעה הזמנית. |
style | CSSProperties | — | סגנונות מוטבעים המוחלים על כרטיס ההודעה הזמנית. |
ref | Ref<HTMLDivElement> | — | ref לאלמנט כרטיס ההודעה הזמנית. |
slotProps | ToastRootSlotProps | — | מאפיינים לכרטיסי הודעות זמניות ולתוכן שהם יוצרים; ניתן למקד משבצות חוזרות לפי מזהה הודעה. |
toast* | ToastRecord | — | הרשומה מהתור להצגה, עם id, כותרת, תיאור, פעולה, משך ועדיפות לאחר קביעת ערכיהם. |
Toast.Title
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
className | string | — | המחלקה המוחלת על אלמנט הכותרת. |
children | ReactNode | — | תוכן הכותרת. |
Toast.Description
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
className | string | — | המחלקה המוחלת על אלמנט התיאור. |
children | ReactNode | — | תוכן התיאור. |
Toast.Action
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
className | string | — | המחלקה המוחלת על כפתור הפעולה. |
onClick | (event: MouseEvent<HTMLButtonElement>) => void | — | נקראת בלחיצה על כפתור הפעולה. |
children | ReactNode | — | תוכן כפתור הפעולה. |
Toast.Close
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
className | string | — | המחלקה המוחלת על כפתור הסגירה. |
onClick | (event: MouseEvent<HTMLButtonElement>) => void | — | נקראת בלחיצה על כפתור הסגירה. |
children | ReactNode | — | תוכן כפתור הסגירה. |
useToast().toast(input)
| מאפיין | טיפוס | ברירת מחדל | תיאור |
|---|---|---|---|
title | ReactNode | — | שורת הכותרת של ההודעה הזמנית. |
description | ReactNode | — | שורה משלימה מתחת לכותרת. |
action | { label: ReactNode; onClick: () => void } | — | תווית ומטפל אירוע לכפתור פעולה יחיד בהודעה הזמנית. |
duration | number | 4000 | מספר אלפיות השנייה לפני שההודעה הזמנית נסגרת מעצמה; אפס או פחות משאירים אותה עד לסגירה מפורשת. |
priority | "polite" | "assertive" | "polite" | האזור החי שיכריז על ההודעה הזמנית. |
id | string | — | מזהה ההודעה הזמנית; נוצר אוטומטית כשהוא מושמט. |
מקלדת
| מקש | פעולה |
|---|---|
| Tab | מיקוד כפתורי פעולה בתוך ההודעה |
| Escape | סגירה כאשר ניתן לסגור |
נגישות
הכרזות polite/assertive באזור חי; הוספה לתור אינה מזיזה את המיקוד, וריחוף או מיקוד משהים סגירה אוטומטית.
נקודות חיבור לעיצוב
data-statedata-part="item"data-part="title"data-part="description"data-part="action"data-part="close"