Документация исходного кода; установленный выпуск может отличаться.

Типы пользовательских видов

English

В этом пакете лежат базовый класс ProjectView и объявления TypeScript, которыми пользуются сторонние виды для Projects Plus. Он происходит от расширения пользовательских видов в Obsidian Projects Marcus Olsson.

Начните с русского справочника API или English API reference: там регистрация, жизненный цикл и пример.

Совместимость

API экспериментальный. Этот каталог объявляет версию пакета 3.0.0 — она не совпадает с версией плагина. Собираясь под конкретный выпуск, сравните index.ts с customViewApi.ts хоста. Пакет не является полной копией текущего хоста: в нём, в частности, нет updateProps и полного описания фильтров. Различия, важные автору вида, описаны в справочнике API.

Используйте экземпляр viewApi, который передаёт хост. Класс из этого пакета содержит пустые тела методов — он нужен для типизации: его создание не даёт работающей службы сохранения, а его идентичность не совпадает с идентичностью реализации хоста.

Лицензия

package.json объявляет для этого пакета лицензию MIT. При распространении сохраняйте применимые указания авторства. У самого плагина своя лицензия Apache 2.0.

Исходник страницы ↗