Кастомизация ToDo

ToDo - это комплексный виджет, разработанный с помощью MV* фреймворка Webix Jet. Виджет представляет собой готовое приложение с минимальной конфигурацией и специальным API для переопределения логики внутренних модулей.

Природа Jet-приложения и внутренние модули

ToDo построен как Jet приложение в обёртке Webix компонента, поэтому вы можете инициализировать его любым из двух способов.

Компоненты

Интерфейс ToDo разделен на части (компоненты). Каждый компонент - класс, который наследуется от класса JetView со своими методами и конфигурацией.

Исходный код частей интерфейса (компонентов Jet) находится в папке sources/views.

views
  active.js
  add.js
  ...
  windows
    context.js

На странице карты классов представлен список используемых компонентов, а также их расположение в интерфейсе.

Модели/Сервисы

В моделях ToDo описана логика для загрузки, хранения и кэширования данных, скачивания файлов, визуализации прогресса операций сохранения и др. В Webix Jet модели называются сервисами.

Исходный код для моделей (сервисов Jet) находятся в папке sources/models.

models
  Backend.js
  Helpers.js
  Local.js
  Operations.js

Вы можете получить сервис с помощью метода getService():

$$('todo').getService('helpers');

Кастомизация компонентов

• вы можете переопределять метод config() для изменений в UI
• вы можете переопределять метод init() для изменений в UI и поведении компонентов
• вы можете переопределять любой метод, но с осторожностью
• вы можете создавать и вызывать свои методы

Для начала создайте класс и наследуйте его от класса по умолчанию или от todo.views.JetView:

class MyToolbar extends todo.views["toolbar"] {
    config() {
        // получаем JSON объект с конфигурацией
        const ui = super.config();
        ... // изменения конкретного компонента
        return ui;
    }
    init() {
        // вызываем логику по умолчанию
        super.init();
        // пользовательский метод
        this.doSomething();
    }
    doSomething() {
        // какое-либо действие при инициализации
    }
}

Затем переопределите компонент (класс) по умолчанию с помощью свойства override:

webix.ui({
    view: "todo",
    data: base_data,
    users: users,
    projects: projects,
    override: new Map([[todo.views["toolbar"], MyToolbar]])
})

Рекомендации

1. Мы не рекомендуем удалять компоненты из интерфейса, т.к. внутренняя логика может всё ещё обращаться к ним. Вместо этого вы можете скрывать компоненты.

class CustomToolbar extends todo.views["toolbar"] {
    init(view) {
        // логика по умолчанию
        super.init();
        // безопасное скрытие компонента
        view.queryView('button').hide();
    }
}

2. Получить экземпляр компонента внутри Jet можно следующими способами:

• с помощью метода $$(id) JetView.

Метод работает для внутреннего компонента, у которого определён локальный ID (localId).

init() {
    // исходная логика
    super.init();
    // получаем экземпляр компонента с localId = "list" 
    const list = this.$$("list");
}

• с помощью queryView, если localId не определён.

init(view) {
    // исходная логика
    super.init();
    // получаем экземпляр кнопки
    const button = view.queryView("button");
}

3. С помощью кода ниже можно определить, в компактном ли режиме приложение в данный момент:

const compact = this.getParam('compact', true);

4. Чтобы получить текущее состояние приложения и его реактивные свойства, воспользуйтесь одним из способов ниже:

const state = this.app.getState();
// или
const state = this.getParam('state');

Кастомизация сервисов Jet

С помощью кастомизации сервисов Jet вы можете добавлять и вызывать свои методы. Также вы можете переопределять любые существующие методы, но с осторожностью.

Прежде всего создайте свой класс сервиса и наследуйте его от класса сервиса по умолчанию:

class MyBackend extends todo.services.Backend {
    getModules() {
        // клиентские данные
        return webix.promise.resolve(modules);
    }
}

Затем переопределите класс по умолчанию с помощью свойства override.

webix.ui({
    view: "todo",
    url: 'https://docs.webix.com/todo-backend/',
    override: new Map([[todo.services.Backend, MyBackend]]),
});

Обратная совместимость

ToDo - это очень гибкий виджет в отношении кастомизаций. Однако следует помнить о следующих моментах:

• Внутренняя логика модулей ToDo может меняться в последующих релизах.
• Мы сделаем всё, чтобы оставить сигнатуры методов без изменений, но в случае необходимости возможны критические изменения.

Наверх