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	顯示當前版本

貢獻小部件

在這裡，您可以找到共享您創建的小部件的說明