@webui-dev/bun-webui
v2.5.4
Published
Use any web browser as GUI, with Bun in the backend and HTML5 in the frontend.
Maintainers
dragahassanReadme
Bun-WebUI v2.5.4 (Beta)
Use any web browser or WebView as GUI, with Bun in the backend and modern web technologies in the frontend, all in a lightweight portable library.
Features
- Portable (Needs only a web browser or a WebView at runtime)
- Lightweight (Few Kb library) & Small memory footprint
- Fast binary communication protocol
- Multi-platform & Multi-Browser
- Using private profile for safety
- Cross-platform WebView
Screenshot
This hello world example is written in Bun using WebUI as the GUI library.
NPM Installation
npm install @webui-dev/bun-webuiImport Package
import { WebUI } from '@webui-dev/bun-webui';Minimal Example
import { WebUI } from '@webui-dev/bun-webui';
const myWindow = new WebUI();
myWindow.show('<html><script src="webui.js"></script> Hello World! </html>');
await WebUI.wait();bun run minimal.tsDocumentation
- Online Documentation (Deno section is the same as Bun)
CppCon 2019 Presentation
Borislav Stanimirov explained at C++ Conference 2019 (YouTube) how beneficial it is to use the web browser as GUI.
UI & The Web Technologies
Web application UI design is not just about how a product looks but how it works. Using web technologies in your UI makes your product modern and professional, And a well-designed web application will help you make a solid first impression on potential customers. Great web application design also assists you in nurturing leads and increasing conversions. In addition, it makes navigating and using your web app easier for your users.
Why Use Web Browser?
Today's web browsers have everything a modern UI needs. Web browsers are very sophisticated and optimized. Therefore, using it as a GUI will be an excellent choice. While old legacy GUI lib is complex and outdated, a WebView-based app is still an option. However, a WebView needs a huge SDK to build and many dependencies to run, and it can only provide some features like a real web browser. That is why WebUI uses real web browsers to give you full features of comprehensive web technologies while keeping your software lightweight and portable.
How does it work?
Think of WebUI like a WebView controller, but instead of embedding the WebView controller in your program, which makes the final program big in size, and non-portable as it needs the WebView runtimes. Instead, by using WebUI, you use a tiny static/dynamic library to run any installed web browser and use it as GUI, which makes your program small, fast, and portable. All it needs is a web browser.
Runtime Dependencies Comparison
| | Tauri / WebView | Qt | WebUI | | ------------------------------- | ----------------- | -------------------------- | ------------------- | | Runtime Dependencies on Windows | WebView2 | QtCore, QtGui, QtWidgets | A Web Browser | | Runtime Dependencies on Linux | GTK3, WebKitGTK | QtCore, QtGui, QtWidgets | A Web Browser | | Runtime Dependencies on macOS | Cocoa, WebKit | QtCore, QtGui, QtWidgets | A Web Browser |
Supported Web Browsers
| Browser | Windows | macOS | Linux | | --------------- | --------------- | ------------- | --------------- | | Mozilla Firefox | ✔️ | ✔️ | ✔️ | | Google Chrome | ✔️ | ✔️ | ✔️ | | Microsoft Edge | ✔️ | ✔️ | ✔️ | | Chromium | ✔️ | ✔️ | ✔️ | | Yandex | ✔️ | ✔️ | ✔️ | | Brave | ✔️ | ✔️ | ✔️ | | Vivaldi | ✔️ | ✔️ | ✔️ | | Epic | ✔️ | ✔️ | not available | | Apple Safari | not available | coming soon | not available | | Opera | coming soon | coming soon | coming soon |
Supported Languages
| Language | v2.4.0 API | v2.5.0 API | Link | | --------------- | --- | -------------- | --------------------------------------------------------- | | Python | ✔️ | not complete | Python-WebUI | | Go | ✔️ | not complete | Go-WebUI | | Zig | ✔️ | not complete | Zig-WebUI | | Nim | ✔️ | not complete | Nim-WebUI | | V | ✔️ | not complete | V-WebUI | | Rust | not complete | not complete | Rust-WebUI | | TS / JS (Deno) | ✔️ | not complete | Deno-WebUI | | TS / JS (Bun) | not complete | not complete | Bun-WebUI | | Swift | not complete | not complete | Swift-WebUI | | Odin | not complete | not complete | Odin-WebUI | | Pascal | not complete | not complete | Pascal-WebUI | | Purebasic | not complete | not complete | Purebasic-WebUI| | - | | | | Common Lisp | not complete | not complete | cl-webui | | Delphi | not complete | not complete | WebUI4Delphi | | C# | not complete | not complete | WebUI4CSharp | | WebUI.NET | not complete | not complete | WebUI.NET | | QuickJS | not complete | not complete | QuickUI | | PHP | not complete | not complete | PHPWebUiComposer |
Supported WebView
| WebView | Status | | --------------- | --------------- | | Windows WebView2 | ✔️ | | Linux GTK WebView | ✔️ | | macOS WKWebView | ✔️ |
License
Licensed under MIT License.