Tài liệu này được dịch bởi AI. Đối với bất kỳ thông tin không chính xác nào, vui lòng tham khảo phiên bản tiếng Anh
EventDefinition định nghĩa logic xử lý sự kiện trong một luồng công việc, dùng để phản hồi các sự kiện kích hoạt cụ thể. Các sự kiện là một cơ chế quan trọng trong FlowEngine để kích hoạt việc thực thi luồng công việc.
EventDefinition thực chất là một bí danh của ActionDefinition, do đó nó có cùng các thuộc tính và phương thức.
Kiểu: string
Bắt buộc: Có
Mô tả: Định danh duy nhất cho sự kiện.
Dùng để tham chiếu sự kiện trong một luồng công việc thông qua thuộc tính on.
Ví dụ:
Kiểu: string
Bắt buộc: Không
Mô tả: Tiêu đề hiển thị cho sự kiện.
Dùng cho việc hiển thị giao diện người dùng (UI) và gỡ lỗi.
Ví dụ:
Kiểu: (ctx: TCtx, params: any) => Promise<any> | any
Bắt buộc: Có
Mô tả: Hàm xử lý cho sự kiện.
Đây là logic cốt lõi của sự kiện, nhận ngữ cảnh và các tham số, sau đó trả về kết quả xử lý.
Ví dụ:
Kiểu: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>)
Bắt buộc: Không
Mô tả: Các tham số mặc định cho sự kiện.
Điền các giá trị mặc định cho tham số khi sự kiện được kích hoạt.
Ví dụ:
Kiểu: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>)
Bắt buộc: Không
Mô tả: Schema cấu hình UI cho sự kiện.
Định nghĩa cách sự kiện hiển thị trong giao diện người dùng và cấu hình biểu mẫu.
Ví dụ:
Kiểu: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Bắt buộc: Không
Mô tả: Hàm hook được thực thi trước khi lưu các tham số.
Được thực thi trước khi các tham số sự kiện được lưu, có thể dùng để xác thực hoặc chuyển đổi tham số.
Ví dụ:
Kiểu: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Bắt buộc: Không
Mô tả: Hàm hook được thực thi sau khi lưu các tham số.
Được thực thi sau khi các tham số sự kiện được lưu, có thể dùng để kích hoạt các hành động khác.
Ví dụ:
Kiểu: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>)
Bắt buộc: Không
Mô tả: Chế độ hiển thị UI cho sự kiện.
Kiểm soát cách sự kiện được hiển thị trong giao diện người dùng.
Các chế độ được hỗ trợ:
'dialog' - Chế độ hộp thoại'drawer' - Chế độ ngăn kéo'embed' - Chế độ nhúngVí dụ:
FlowEngine đã tích hợp sẵn các loại sự kiện phổ biến sau:
'click' - Sự kiện nhấp chuột'submit' - Sự kiện gửi'reset' - Sự kiện đặt lại'remove' - Sự kiện xóa'openView' - Sự kiện mở chế độ xem'dropdownOpen' - Sự kiện mở danh sách thả xuống'popupScroll' - Sự kiện cuộn cửa sổ bật lên'search' - Sự kiện tìm kiếm'customRequest' - Sự kiện yêu cầu tùy chỉnh'collapseToggle' - Sự kiện bật/tắt thu gọn