QuickUI

KO | EN

gitlite — search

#python #javascript #golang #css #java #go #typescript #html #fastapi #github #unity #simulation

★ 46 Open GitHub ↗

A GUI framework based on QuickJs and WebUI

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# QuickUI

- Build desktop apps with JavaScript, HTML, and CSS.
- Based on [QuickJS](https://github.com/quickjs-ng/quickjs) and [WebUI](https://github.com/webui-dev/webui).
- Allow you to use any browser as a GUI render engine.
- Light weight (about **1M**) & Small memory footprint.
- Feature rich.

# Quick Start

```js
const win = new Win();
win.show("<html><script src=\"webui.js\"></script> Hello World! </html>");
webui.wait();
```

1. Save this code in `main.js`.
1. Place `main.js` in the same directory as `QuickUI.exe`.
1. Start `QuickUI.exe`.

# API

## webui

### wait
```js
// 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();
```

### exit
```js
// 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();
```

### setTimeout
```js
// 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();
```

```js
// main.js
// Set wait forever
webui.setTimeout(0);
// Now, wait() will never end.
webui.wait();
```

## Win

`Win` is a class.

### show
```js
// 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();
```
```js
// create window object.
const win = new Win();
// Show a window using a file.
win.show("index.html");
webui.wait();
```

### showBrowser
```js
//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);
```

### setIcon
```js
// 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);
```

### setPosition

```js
// main.js
// Set the window position.
win.setPosition(x,y);
```

### setSize

```js
// main.js
// Set the window size.
win.setSize(width,height);
```

### navigate

```js
// main.js
// Navigate to a specific URL
let url = "page.html";
win.navigate(url);
```

### getUrl

```js
// main.js
// Get the full current URL.
let url = win.getUrl(url);
```

### setKiosk

```js
// main.js
// Set the window in Kiosk mode
const win = new Win();
win.setKiosk(true);
win.show("index.html");
```

### setPublic

```js
//Allow a specific window address to be accessible from a public network.
win.setPublic(true);
```

### setProxy

```js
//Set the web browser proxy_server to use. Need to be called before `webui_show()`.
win.setProxy("http://127.0.0.1:8888");
```

### setRootFolder

```js
//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();
```

### close

```js
// main.js
// Close a specific window only. The window object will still exist.
win.close();
```

### destroy

```js
// main.js
// Close a specific window and free all memory resources.
win.destroy();
```

### run

```js
// main.js
// Run JavaScript without waiting for the response.
win.run(`alert("hello world.");`);
```

### bind

```js
// 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); //
});
```

## global

QuickJs doesn't have `console.log` but QuickUI do.

```js
//main.js
console.log("hello world!");
webui.setTimeout(0); //set wait forever.
webui.wait(); //now wait forever.
```

## os

QuickJs sets the `setTimeout` and `setInterval` methods inside the `os` module.

### setTimeout

```js
//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.
```

### setInterval

```js
//main.js
import * as os from "os";
os.setInterval(() => {
    console.log("interval");
}, 1000);
webui.setTimeout(0); //set wait forever.
webui.wait(); //now wait forever.
```

# TypeScript Support

The Declaration File :

- [quickui.d.ts](QuickUI/ui/main/quickui.d.ts)
- [os.d.ts](QuickUI/ui/main/os.d.ts)

QuickUI

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README