widget builder

Pembangun widget

Kembangkan, menginstal, dan mendistribusikan widget HTML untuk desktop Windows Anda dengan CLI sederhana

Daftar isi

1. Instalasi
2. Panduan QuickStart
3. Sampel
4. Menerbitkan dan menginstal
   1. Penerbitan
   2. Menginstal
5. File konfigurasi
6. Menggunakan CLI
7. Widget yang berkontribusi

Instalasi

Unduh, unzip, navigasikan ke folder, dan instal dengan npm :

 $ npm install -g
$ npm start

atau unduh langsung dari npm :

 $ npm install -g widget-builder

Panduan QuickStart

1. Buat folder baru
2. cd ke folder, masukkan widgets init , dan isi nama proyek Anda
3. Berantakan dengan file HTML yang dihasilkan untuk menyesuaikan penampilan widget Anda
4. Tambah dan tautkan file JavaScript atau CSS ke file HTML Master Anda
5. Ubah file konfigurasi
6. Arahkan ke folder dan masukkan widgets build untuk membangun secara lokal dan instal widget Anda

Sampel

Lihatlah Spotify Listener, widget untuk mendengarkan lagu favorit Anda:

Menerbitkan dan Menginstal Widget

Penerbitan

Jadi, Anda ingin membagikan widget Anda untuk distribusi? Inilah yang harus dilakukan:

1. cd ke folder proyek Anda
2. Jalankan widgets publish
3. Folder dist baru akan dihasilkan di direktori yang sama dengan folder proyek Anda. Anda sekarang dapat mendistribusikan folder ini, dan yang lain dapat menginstalnya dengan widgets install

Menginstal

Inilah cara menginstal widget yang dibagikan kepada Anda:

1. Arahkan ke folder
2. Jalankan widgets install

File konfigurasi

Setiap proyek widget berisi file config.json . File ini memberi tahu program pengaturan apa yang ingin Anda gunakan untuk widget Anda.
Berikut file konfigurasi standar:

{
  "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
  }
}

Milik	Definisi
name (string)	Nama proyek
version (String)	Versi Proyek
index (string)	Referensi ke file html master Anda. Referensi lain (seperti JS atau CSS) harus ditautkan dalam file ini.
x , y , width , dan height (bilangan bulat)	Posisi dan dimensi widget Anda saat pertama kali memulai
transparent (Boolean)	Jadikan latar belakang widget transparan
interact (boolean)	Jadikan widget yang bisa diinteraksi
draggable (Boolean)	Jadikan widget yang bisa diseret
top (Boolean)	Buat widget tetap di atas semua jendela
requirements (array)	Paket NPM diperlukan agar widget berfungsi; Paket -paket ini dipasang secara lokal saat widget diinstal
install (string atau array)	Skrip untuk dijalankan selama instalasi widget

Menggunakan CLI

Setelah pembangun widget diinstal, CLI dapat diakses dengan widgets kata kunci

Perintah

Memerintah	Definisi
widgets build [folder]	Membangun file html ke widget desktop dan menginstal
widgets publish [folder]	Menghasilkan file dist yang dapat diinstal oleh widget CLI
widgets install [folder]	Menginstal widget di folder
widgets init [folder]	Menginisialisasi proyek widget
widgets list	Daftar semua widget yang diinstal
widgets uninstall <widget>	Uninstall widget berdasarkan nama
widgets config <widget>	Konfigurasikan widget dengan nama
widgets start [folder]	Mulai widget di folder

Opsi

Memerintah	Definisi
widgets --help	Tunjukkan Bantuan
widgets --version	Menampilkan versi saat ini

Widget yang berkontribusi

Di sini Anda dapat menemukan instruksi untuk berbagi widget yang telah Anda buat