API 概览
To Do List 方法
| 名称 | 描述 |
|---|---|
| addProject() | 添加一个新项目 |
| addTask() | 向列表中添加一个新任务 |
| assignUser() | 将人员分配到指定任务 |
| checkTask() | 将任务标记为已完成 |
| closeInlineEditor() | 关闭任务/项目的内联编辑器 |
| collapseTask() | 根据 id 折叠任务 |
| copyTask() | 将任务复制到剪贴板并粘贴到指定位置 |
| deleteProject() | 删除一个项目 |
| deleteTask() | 从 DataStore 中删除指定任务 |
| destructor() | 移除 To Do List 的所有 HTML 元素，并解绑所有相关事件 |
| eachSelected() | 遍历所有选中的任务 |
| existsProject() | 检查指定项目是否存在于 DataStore 中 |
| existsTask() | 检查指定任务是否存在于 DataStore 中 |
| expandTask() | 根据 ID 展开已折叠的任务 |
| getChildrenIds() | 返回指定父任务的子任务 ID 数组 |
| getParentIds() | 返回指定子任务的父任务 ID 数组 |
| getProject() | 根据 ID 获取项目对象 |
| getSelection() | 获取包含已选中任务 ID 的数组 |
| getTask() | 根据 ID 获取任务对象 |
| hasChildren() | 检查指定任务是否有子任务 |
| hideCompletedTasks() | 将 To Do List 切换到隐藏已完成任务的模式 |
| indentTask() | 根据相邻任务将该任务的嵌套级别降低一级 |
| moveTask() | 将任务移动到指定位置 |
| openInlineEditor() | 打开任务/项目的内联编辑器 |
| parse() | 将数据加载到 To Do List 中 |
| pasteTask() | 将剪贴板中已复制的任务粘贴到指定位置 |
| redo() | 重复执行被 undo 操作撤销的动作 |
| selectTask() | 通过 ID 选中指定的任务 |
| serialize() | 将 To Do List 的数据序列化为 JSON 对象 |
| setConfig() | 为 To Do List 设置新的配置 |
| setLocale() | 为 To Do List 设置指定的语言环境 |
| setFilter() | 在当前活动项目中按指定条件筛选任务 |
| setProject() | 将指定项目设置为当前活动项目 |
| setSort() | 按指定参数对当前项目的任务进行排序 |
| showCompletedTasks() | 将 To Do List 切换到在页面上显示已完成任务的模式 |
| unassignUser() | 将指定人员从指定任务中取消分配 |
| uncheckTask() | 将任务标记为未完成 |
| undo() | 撤销 To Do List 中的最后一次操作 |
| unindentTask() | 根据相邻任务将任务的嵌套层级提升一级 |
| unselectTask() | 取消选中一个或多个任务 |
| updateProject() | 更新项目的配置参数 |
| updateTask() | 更新任务的配置参数 |
To Do List 内部 API
Event Bus 方法
| 名称 | 描述 |
|---|---|
| api.exec() | 允许触发内部事件 |
| api.intercept() | 允许拦截并阻止内部事件 |
| api.on() | 允许为内部事件绑定处理函数 |
| api.setNext() | 允许将某个操作添加到 Event Bus 队列中 |
State 方法
| 名称 | 描述 |
|---|---|
| api.getReactiveState() | 获取包含 To Do List 的 DataStore 响应式属性的对象 |
| api.getState() | 获取包含 To Do List 的 DataStore 当前属性的对象 |
| api.getStores() | 获取包含 To Do List 的 DataStore 对象的对象 |
To Do List 事件
| 名称 | 描述 |
|---|---|
| add-project | 添加新项目时触发 |
| add-task | 添加新任务时触发 |
| assign-user | 将用户分配到任务时触发 |
| check-task | 将任务标记为已完成时触发 |
| clone-task | 将任务从剪贴板粘贴到指定位置时触发 |
| close-inline-editor | 关闭任务/项目的内联编辑器时触发 |
| close-menu | 关闭菜单时触发 |
| collapse-task | 折叠任务时触发 |
| copy-task | 任务被复制到剪贴板时触发 |
| delete-project | 删除项目时触发 |
| delete-task | 删除任务时触发 |
| drag | 用户拖动任务时触发 |
| edit-item | 通过内联编辑器编辑任务/项目的值时触发 |
| end-drag | 当任务拖拽操作完成时触发 |
| expand-task | 当展开任务时触发 |
| hide-completed-tasks | 当 To Do List 切换到隐藏已完成任务的模式时触发 |
| indent-task | 当任务的嵌套层级降低一级时触发 |
| keypress-on-todo | 当使用键盘导航时任务处于焦点状态时触发 |
| move-task | 当移动任务时触发 |
| open-inline-editor | 当打开任务/项目的内联编辑器时触发 |
| open-menu | 当菜单打开 时触发 |
| paste-task | 当任务从剪贴板粘贴到指定位置时触发 |
| select-task | 当选中一个任务时触发 |
| set-filter | 当按指定条件过滤数据时触发 |
| set-project | 当切换当前活动项目时触发 |
| set-sort | 当对任务进行排序时触发 |
| show-completed-tasks | 当 To Do List 切换到显示已完成任务的模式时触发 |
| start-drag | 当用户开始拖拽任务时触发 |
| unassign-user | 当用户从任务中取消分配时触发 |
| uncheck-task | 当任务被标记为未完成时触发 |
| unindent-task | 当任务的嵌套级别提升一级时触发 |
| unselect-task | 当取消选中任务时触发 |
| update-project | 当更新项目时触发 |
| update-task | 当更新任务时触发 |
To Do List 属性
| 名称 | 描述 |
|---|---|
| activeProject | 可选。当前激活项目的 ID |
| drag | 可选。指定拖放操作的相关设置 |
| history | 可选。启用/禁用变更历史记录管理功能 |
| id | 可选。To Do List 的 ID |
| locale | 可选。为组件应用指定的语言环境 |
| menu | 可选。指定右键菜单的显示状态（布尔值）或配置参数（函数） |
| priorities | 可选。指定包含优先级数据的对象数组 |
| projects | 可选。指定一个项目对象数组，用于设置到列表中 |
| readonly | 可选。将 To Do List 设置为只读模式 |
| selected | 可选。包含任务 ID 的数组，这些任务将在 To Do List 初始化时被选中 |
| tags | 可选。默认显示的井号标签数组 |
| tasks | 可选。指定一个任务对象数组，用于设置到列表中 |
| taskShape | 可选。包含任务外观设置的对象 |
| users | 可选。指定一个包含用户数据的对象数组 |