API 概览
Booking 构造函数
new booking.Booking("#root", {
// 初始配置参数
});
参数:
- HTML 容器或其 ID 选择器(
HTMLElement | string) - 配置参数对象(查看详情)
Booking 方法
| 名称 | 描述 |
|---|---|
| serialize() | 将 Booking 数据序列化为 JSON 数组 |
| setConfig() | 更新 Booking widget 的当前配置 |
| setConfirmHandler() | 注册一个用于 confirm-slot 事件的处理函数 |
| setLocale() | 为 Booking 应用新的语言环境 |
Booking 内部 API
Event Bus 方法
| 名称 | 描述 |
|---|---|
| api.detach() | 用于移除/解绑事件处理器 |
| api.exec() | 允许触发内部事件 |
| api.intercept() | 允许拦截并阻止内部事件 |
| api.on() | 允许将处理函数绑定到内部事件 |
| api.setNext() | 将自定义处理程序添加到 widget Event Bus 链的末尾 |
State 方法
| 名称 | 描述 |
|---|---|
| api.getReactiveState() | 获取包含 Booking 响应式属性的对象 |
| api.getState() | 获取包含 Booking StateStore 属性的对象 |
Booking 事件
| 名称 | 描述 |
|---|---|
| confirm-slot | 在确认预订时段时触发 |
| filter-data | 当过滤器被应用时触发 |
| select-item | 当选中某个条目时触发 |
| select-item-date | 当为某个 条目选择日期时触发 |
| select-slot | 选择时间段时触发 |
Booking 属性
| 名称 | 描述 |
|---|---|
| data | 可选。包含卡片数据的对象数组 |
| end | 可选。定义显示可用时间段的截止日期 |
| cardShape | 可选。一个对象,用于管理每张卡片左侧显示的信息 |
| cardTemplate | 可选。允许为卡片左侧区块应用自定义模板 |
| filterShape | 可选。用于管理筛选功能的配置对象 |
| formShape | 可选。一个对象数组,包含用于配置 Booking 对话框中字段的设置 |
| infoShape | 可选。一个对象,用于配置 Booking 对话框左侧显示的信息内容 |
| infoTemplate | 可选。允许为 Booking 对话框中的信息块应用模板 |
| locale | 可选。Booking 自定义语言环境的对象 |
| renderType | 可选。定义 卡片的渲染方式 |
| slotGap | 可选。为所有卡片定义预约时间槽之间的间隔 |
| slotSize | 可选。定义所有卡片的预约时间段时长 |
| start | 可选。定义开始显示可用时间段的日期 |