- Build desktop apps with JavaScript, HTML, and CSS.
- Based on QuickJs and WebUI.
- Allow you to use any browser as a GUI render engine.
- Light weight (about 1M) & Small memory footprint.
- Feature rich (clipboard, tray, sqlite...).
const win = new Win();
win.show("<html><script src=\"webui.js\"></script> Hello World! </html>");
webui.wait();
- Save this code in
main.js
. - Place
main.js
in the same directory asQuickUI.exe
. - Start
QuickUI.exe
.
// main.js
// If There is one or more browser window,
// wait until all browser window get closed or when calling webui_exit().
// else if the browser did not get started, wait() will break after 30 seconds.
webui.wait();
// main.js
// Try to close all opened windows and make wait return.
// All WebUI memory resources will be freed, and this will makes WebUI unusable.
webui.exit();
// main.js
// Set wait 10 seconds for the browser to start.
webui.setTimeout(10);
// Now, After 10 seconds, if the browser did not get started, wait() will break.
webui.wait();
// main.js
// Set wait forever
webui.setTimeout(0);
// Now, wait() will never end.
webui.wait();
Win
is a class.
// create window object.
const win = new Win();
// Show a window using embedded HTML.
win.show("<html><script src=\"webui.js\"></script> Hello World! </html>");
webui.wait();
// create window object.
const win = new Win();
// Show a window using a file.
win.show("index.html");
webui.wait();
//main.js
// Same as `win.show`. But using a specific web browser.
// 0: No web browser
// 1: Default recommended web browser
// 2: Google Chrome
// 3: Mozilla Firefox
// 4: Microsoft Edge
// 5: Apple Safari
// 6: The Chromium Project
// 7: Opera Browser
// 8: The Brave Browser
// 9: The Vivaldi Browser
// 10: The Epic Browser
// 11: The Yandex Browser
// 12: Any Chromium based browser
win.showBrowser("index.html",2);
// main.js
// Set the default embedded HTML favicon.
// myIcon = "<svg>...</svg>"
// myIconType = "image/svg+xml"
//
// myIcon = "data:image/..."
// myIconType = "image/png"
win.setIcon(myIcon,myIconType);
// main.js
// Set the window position.
win.setPosition(x,y);
// main.js
// Set the window size.
win.setSize(width,height);
// main.js
// Navigate to a specific URL
let url = "page.html";
win.navigate(url);
// main.js
// Get the full current URL.
let url = win.getUrl(url);
// main.js
// Set the window in Kiosk mode
const win = new Win();
win.setKiosk(true);
win.show("index.html");
//Allow a specific window address to be accessible from a public network.
win.setPublic(true);
//Set the web browser proxy_server to use. Need to be called before `webui_show()`.
win.setProxy("https://127.0.0.1:8888");
//Set the web-server root folder path for a specific window.
const win = new Win();
win.setRootFolder("ui") //Path relative to QuickUI.exe or full path
win.show("index.html");
webui.wait();
// main.js
// Close a specific window only. The window object will still exist.
win.close();
// main.js
// Close a specific window and free all memory resources.
win.destroy();
// main.js
// Run JavaScript without waiting for the response.
win.run(`alert("hello world.");`);
// main.js
// Bind a specific html element click event with a function. Empty element means all events.
let bindId = win.bind("domID", (e)=>{
console.log(e.bindId); //
console.log(e.windowId);
console.log(e.elementId); // "domID"
console.log(e.eventNumber); // increased when event occur
// 0: Window disconnection event
// 1: Window connection event
// 2: Mouse click event
// 3: Window navigation event
// 4: Function call event
console.log(e.eventType); //
});
QuickJs doesn't have console.log
but QuickUI do.
//main.js
console.log("hello world!");
webui.setTimeout(0); //set wait forever.
webui.wait(); //now wait forever.
QuickJs sets the setTimeout
and setInterval
methods inside the os
module.
//main.js
import * as os from "os";
os.setTimeout(() => {
console.log("time out");
}, 1000);
webui.setTimeout(0); //set wait forever.
webui.wait(); //now wait forever.
//main.js
import * as os from "os";
os.setInterval(() => {
console.log("interval");
}, 1000);
webui.setTimeout(0); //set wait forever.
webui.wait(); //now wait forever.
The Declaration File : quick.d.ts