widget builder

Виджет -строитель

Разработать, установить и распространять HTML -виджеты для вашего рабочего стола Windows с простым CLI

Оглавление

1. Установка
2. QuickStart Guide
3. Образцы
4. Публикация и установка
   1. Издательский
   2. Установка
5. Файл конфигурации
6. Используя CLI
7. Вклад виджеты

Установка

Загрузите, раскачивайте, перейдите в папку и установите с npm :

 $ npm install -g
$ npm start

или скачать непосредственно с npm :

 $ npm install -g widget-builder

QuickStart Guide

1. Создать новую папку
2. cd в ​​папку, введите widgets init и заполните имя вашего проекта
3. Объединяется с сгенерированным HTML -файлом, чтобы настроить внешний вид вашего виджета
4. Добавить и ссылаться на файлы JavaScript или CSS в свой мастер HTML -файл
5. Измените файл конфигурации
6. Перейдите к папке и введите widgets build в локальную сборку и установите свой виджет

Образцы

Проверьте Spotify Helloader, виджет для прослушивания ваших любимых мелодий:

Публикация и установка виджетов

Издательский

Значит, вы хотите поделиться своим виджетом для распространения? Вот что делать:

1. cd в ​​папку проекта
2. widgets publish
3. В том же каталоге будет сгенерирована новая папка dist , что и в папке проекта. Теперь вы можете распространять эту папку, а другие могут установить ее с widgets install

Установка

Вот как установить виджет, который был разделен с вами:

1. Перейдите к папке
2. Запустить widgets install

Файл конфигурации

Каждый проект виджетов содержит файл config.json . Этот файл сообщает программе, какие настройки вы хотели бы использовать для своего виджета.
Вот стандартный файл конфигурации:

{
  "name" : " widget " ,
  "version" : " 1.0.0 " ,
  "description" : " Custom desktop widget " ,
  "index" : " ./index.html " ,
  "properties" : {
    "x" : 100 ,
    "y" : 100 ,
    "width" : 100 ,
    "height" : 100 ,
    "transparent" : false ,
    "interact" : true ,
    "draggable" : true
  }
}

Свойство	Определение
name (строка)	Название проекта
version (строка)	Версия проекта
index (строка)	Ссылка на ваш мастер HTML -файл. Другие ссылки (например, JS или CSS) должны быть связаны в этом файле.
x , y , width и height (целые числа)	Положение и размеры вашего виджета, когда он первым запускается
transparent (логический)	Сделайте фон виджета прозрачным
interact (логическое)	Заставить виджет взаимодействовать
draggable (логическое)	Сделайте затягивание виджета
top (логический)	Сделайте виджет оставаться на вершине всех окон
requirements (массив)	Пакеты NPM, необходимые для функционирования виджета; Эти пакеты локально установлены при установке виджет
install (строка или массив)	Сценарии (ы) для запуска во время установки виджетов

Используя CLI

После установки виджетов CLI можно получить с помощью widgets ключевых слов

Команды

Командование	Определение
widgets build [folder]	Создает HTML -файлы в виджет настольных компьютеров и устанавливает
widgets publish [folder]	Генерирует файл DIST, который может быть установлен CLI Vidgets
widgets install [folder]	Установка виджет в папке
widgets init [folder]	Инициализирует проект виджетов
widgets list	Списки всех установленных виджетов
widgets uninstall <widget>	Удалить виджет по имени
widgets config <widget>	Настроить виджет по имени
widgets start [folder]	Запускает виджет в папке

Параметры

Командование	Определение
widgets --help	Показать помощь
widgets --version	Отображает текущую версию

Вклад виджеты

Здесь вы можете найти инструкции по обмену виджетами, которые вы создали