Изображения плагина

Картинки хранятся внутри .dgplugin. Поддерживаются PNG, JPEG и WebP. SVG, GIF и Lottie не относятся к поддерживаемым изображениям этого SDK.

Значок плагина

Положите картинку в assets/icon.png и укажите путь в manifest.json:

{
  "icon": "assets/icon.png"
}

Это фрагмент манифеста. Сам файл должен присутствовать в пакете. Значок используется в шторке установки, списке плагинов и превью документа в чате после его загрузки и проверки.

Внешняя ссылка вместо пути не поддерживается. Если значка нет или изображение не прошло проверку, показывается стандартный значок плагина. Для одиночного .donut.js отдельного файла картинки нет.

Изображение на своей странице

Получите непрозрачный handle через assets.image, затем передайте его узлу image. Для такой страницы требуется ui.contribute / settings.

const image = await api.assets.image({ path: "assets/preview.webp" });

await api.ui.render({
  id: "preview",
  title: "Предпросмотр",
  nodes: [
    { id: "picture", type: "image", asset: image },
    { id: "caption", type: "text", text: "Изображение из пакета" }
  ]
});

Время жизни

Handle изображения принадлежит текущему плагину и поколению runtime. Не сохраняйте его в настройки или storage для использования после перезапуска. После повторного запуска запросите handle снова.

Подготовка файлов

Экспортируйте изображения в разумном разрешении, уберите лишние метаданные и проверьте результат в светлой и тёмной теме. Несимметричная картинка вписывается в квадрат значка без растягивания.

Пути относительные и чувствительны к структуре пакета. Проверка validate поможет найти неподдерживаемый ресурс до установки.