מסמך זה תורגם על ידי בינה מלאכותית. לכל אי דיוק, אנא עיין בגרסה האנגלית
EventDefinition מגדיר את לוגיקת הטיפול באירועים בתוך זרימה, ומשמש לתגובה לטריגרים ספציפיים של אירועים. אירועים הם מנגנון חשוב במנוע הזרימה להפעלת ביצוע זרימות.
EventDefinition הוא למעשה כינוי ל-ActionDefinition, ולכן יש לו את אותם המאפיינים והמתודות.
טיפוס: string
נדרש: כן
תיאור: מזהה ייחודי לאירוע.
משמש להפניה לאירוע בזרימה באמצעות המאפיין on.
דוגמה:
טיפוס: string
נדרש: לא
תיאור: כותרת התצוגה של האירוע.
משמש לתצוגת ממשק משתמש ולניפוי באגים.
דוגמה:
טיפוס: (ctx: TCtx, params: any) => Promise<any> | any
נדרש: כן
תיאור: פונקציית הטיפול (handler) של האירוע.
זוהי לוגיקת הליבה של האירוע, המקבלת את ההקשר (context) והפרמטרים, ומחזירה את תוצאת הטיפול.
דוגמה:
טיפוס: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>)
נדרש: לא
תיאור: פרמטרי ברירת המחדל של האירוע.
מאכלס את הפרמטרים בערכי ברירת מחדל כאשר האירוע מופעל.
דוגמה:
טיפוס: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>)
נדרש: לא
תיאור: סכמת תצורת ממשק המשתמש (UI) של האירוע.
מגדיר את אופן הצגת האירוע בממשק המשתמש ואת תצורת הטופס שלו.
דוגמה:
טיפוס: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
נדרש: לא
תיאור: פונקציית וו (hook) המופעלת לפני שמירת הפרמטרים.
מופעלת לפני שמירת פרמטרי האירוע, ויכולה לשמש לאימות או המרה של פרמטרים.
דוגמה:
טיפוס: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
נדרש: לא
תיאור: פונקציית וו (hook) המופעלת לאחר שמירת הפרמטרים.
מופעלת לאחר שמירת פרמטרי האירוע, ויכולה לשמש להפעלת פעולות אחרות.
דוגמה:
טיפוס: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>)
נדרש: לא
תיאור: מצב תצוגת ממשק המשתמש (UI) של האירוע.
שולט באופן שבו האירוע מוצג בממשק המשתמש.
מצבים נתמכים:
'dialog' - מצב דיאלוג (חלון קופץ)'drawer' - מצב מגירה (פאנל צדדי)'embed' - מצב מוטבעדוגמה:
מנוע הזרימה כולל את סוגי האירועים הנפוצים הבאים:
'click' - אירוע לחיצה'submit' - אירוע שליחה'reset' - אירוע איפוס'remove' - אירוע הסרה'openView' - אירוע פתיחת תצוגה'dropdownOpen' - אירוע פתיחת רשימה נפתחת'popupScroll' - אירוע גלילה בחלון קופץ'search' - אירוע חיפוש'customRequest' - אירוע בקשה מותאמת אישית'collapseToggle' - אירוע החלפת מצב כיווץ/הרחבה