Обзор API
Методы To Do List
| Название | Описание |
|---|---|
| addProject() | Добавляет новый проект |
| addTask() | Добавляет новую задачу в список |
| assignUser() | Назначает пользователя на указанную задачу |
| checkTask() | Отмечает задачу как выполненную |
| closeInlineEditor() | Закрывает встроенный редактор задачи/проекта |
| collapseTask() | Сворачивает задачу по её ID |
| copyTask() | Копирует задачу в буфер обмена и вставляет её в указанную позицию |
| deleteProject() | Удаляет проект |
| deleteTask() | Удаляет указанную задачу из DataStore |
| destructor() | Удаляет все HTML-элементы To Do List и отвязывает все связанные события |
| eachSelected() | Перебирает все выбранные задачи |
| existsProject() | Проверяет, существует ли указанный проект в DataStore |
| existsTask() | Проверяет, существует ли указанная задача в DataStore |
| expandTask() | Разворачивает свёрнутую задачу по её идентификатору |
| getChildrenIds() | Возвращает идентификаторы дочерних задач указанной родител ьской задачи |
| getParentIds() | Возвращает идентификаторы родительских задач указанной дочерней задачи |
| getProject() | Возвращает объект проекта по его идентификатору |
| getSelection() | Возвращает массив с идентификатором выбранной задачи |
| getTask() | Возвращает объект задачи по её идентификатору |
| 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() | Обновляет параметры конфигурации задачи |
Внутренний API To Do List
Методы Event Bus
| Название | Описание |
|---|---|
| api.exec() | Позволяет запускать внутренние события |
| api.intercept() | Позволяет перехватывать и блокировать внутренние события |
| api.on() | Позволяет прикреплять обработчик к внутренним событиям |
| api.setNext() | Позволяет добавлять действие в очередь Event Bus |
Методы состояния
| Название | Описание |
|---|---|
| api.getReactiveState() | Возвращает объект с реактивными свойствами DataStore списка To Do List |
| api.getState() | Возвращает объект с текущими свойствами DataStore списка To Do List |
| api.getStores() | Возвращает объект с объектом DataStore списка To Do List |
События 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 | Необязательный. Идентификатор активного проекта |
| drag | Необязательный. Задаёт настройки перетаскивания (drag-n-drop) |
| history | Необязательный. Включает/отключает управление историей изменений |
| id | Необязательный. Идентификатор To Do List |
| locale | Необязательный. Применяет необходимую локаль к компоненту |
| menu | Необязательный. Управляет видимостью контекстного меню (если boolean) или параметрами его настройки (если функция) |
| priorities | Необязательный. Задаёт массив объектов с данными приоритетов |
| projects | Необязательный. Задаёт массив объектов проектов для загрузки в список |
| readonly | Необязательный. Переводит To Do List в режим только для чтения |
| selected | Необязательный. Массив с идентификаторами задач, которые должны быть выделены при инициализации To Do List |
| tags | Необязательный. Массив хэштегов, отображаемых по умолчанию |
| tasks | Необязательный. Задаёт массив объектов задач для загрузки в список |
| taskShape | Необязательный. Объект с настройками внешнего вида задач |
| users | Необязательный. Задаёт массив объектов с данными пользователей |