widget builder

小部件建造者

使用简单的CLI开发，安装和分发Windows桌面的HTML小部件

目录

1. 安装
2. 快速入门指南
3. 样品
4. 发布和安装
   1. 出版
   2. 安装
5. 配置文件
6. 使用CLI
7. 贡献小部件

安装

下载，解压缩，导航到文件夹，然后使用npm安装：

 $ npm install -g
$ npm start

或直接从npm下载：

 $ npm install -g widget-builder

快速入门指南

1. 创建一个新文件夹
2. cd到文件夹，输入widgets init ，然后填写您的项目名称
3. 用生成的HTML文件四处乱逛以自定义小部件的外观
4. 添加并将JavaScript或CSS文件链接到主HTML文件
5. 修改配置文件
6. 导航到文件夹并输入widgets build以本地构建和安装小部件

样品

查看Spotify听众，这是一个聆听您喜欢的音乐的小部件：

发布和安装小部件

出版

因此，您想分享您的小部件以进行分发吗？这是该怎么办：

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 （字符串或数组）	脚本（S）在小部件安装期间运行

使用CLI

一旦安装了小部件构建器，可以使用关键字widgets访问CLI

命令

命令	定义
widgets build [folder]	将HTML文件构建到桌面窗口小部件并安装
widgets publish [folder]	生成一个可以由小部件CLI安装的DIST文件
widgets install [folder]	在文件夹中安装小部件
widgets init [folder]	初始化小部件项目
widgets list	列出所有安装的小部件
widgets uninstall <widget>	按名称卸载小部件
widgets config <widget>	按名称配置小部件
widgets start [folder]	从文件夹启动小部件

选项

命令	定义
widgets --help	显示帮助
widgets --version	显示当前版本

贡献小部件

在这里，您可以找到共享您创建的小部件的说明