2023-07-24 20:31:17 +02:00
< div align = "center" >
2024-07-07 14:20:04 -04:00
2023-05-11 23:26:52 -04:00
2025-03-10 10:14:39 -04:00
# WebUI v2.5.0-beta.4
2021-03-20 19:53:42 -03:00
2023-10-29 01:26:32 -04:00
[build-status]: https://img.shields.io/github/actions/workflow/status/webui-dev/webui/ci.yml?branch=main& style=for-the-badge& logo=githubactions& labelColor=414868& logoColor=C0CAF5
[last-commit]: https://img.shields.io/github/last-commit/webui-dev/webui?style=for-the-badge& logo=github& logoColor=C0CAF5& labelColor=414868
[release-version]: https://img.shields.io/github/v/tag/webui-dev/webui?style=for-the-badge& logo=webtrees& logoColor=C0CAF5& labelColor=414868& color=7664C6
[license]: https://img.shields.io/github/license/webui-dev/webui?style=for-the-badge& logo=opensourcehardware& label=License& logoColor=C0CAF5& labelColor=414868& color=8c73cc
2023-10-29 01:20:18 -04:00
[![][build-status]](https://github.com/webui-dev/webui/actions?query=branch%3Amain)
[![][last-commit]](https://github.com/webui-dev/webui/pulse)
[![][release-version]](https://github.com/webui-dev/webui/releases/latest)
[![][license]](https://github.com/webui-dev/webui/blob/main/LICENSE)
2021-03-20 19:53:42 -03:00
2024-07-07 14:20:04 -04:00
> Use any web browser or WebView as GUI, with your preferred language in the backend and modern web technologies in the frontend, all in a lightweight portable library.
2021-03-20 19:53:42 -03:00
2024-07-07 14:20:04 -04:00
2021-03-20 19:53:42 -03:00
2023-08-22 04:20:17 +02:00
< / div >
2023-04-24 22:11:31 -04:00
2023-09-02 12:17:30 -04:00
## Download
- [Latest Stable Release ](https://github.com/webui-dev/webui/releases )
2023-09-11 23:33:29 -04:00
- [Nightly Build ](https://github.com/webui-dev/webui/releases/tag/nightly )
2023-09-02 12:17:30 -04:00
2023-08-21 23:06:46 +02:00
## Contents
- [Features ](#features )
- [Showcase ](#showcase )
- [UI & The Web Technologies ](#ui--the-web-technologies )
- [Documentation ](#documentation )
- [Build ](#build )
- [Examples ](#examples )
- [Wrappers ](#wrappers )
- [Supported Web Browsers ](#supported-web-browsers )
- [License ](#license )
2021-03-20 19:53:42 -03:00
## Features
2024-05-27 16:19:00 -04:00
- Portable (*Needs only a web browser or a WebView at runtime*)
2022-09-24 20:34:28 -03:00
- One header file
2023-11-29 18:23:54 -05:00
- Lightweight (*Few Kb library*) & Small memory footprint
- Fast binary communication protocol
2022-10-29 21:41:20 -04:00
- Multi-platform & Multi-Browser
2022-10-30 15:29:10 -04:00
- Using private profile for safety
2024-05-27 16:19:00 -04:00
- Cross-platform WebView
2022-10-30 15:29:10 -04:00
2023-08-21 23:06:46 +02:00
## UI & The Web Technologies
WebUI v2.0.7
* Switch from GPL to LGPL
* Deno example is ready
* Adding `void _webui_free_all_mem()` to release all dynamic mem at exit
* Break Change `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char* data)` to `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char** data)`
* Updating readme
* Moving Zig build file into build folder
More code cleaning and more examples is needed before we release the version 2.0.7.
2023-03-21 18:47:19 -04:00
2023-10-08 03:01:02 +02:00
[Borislav Stanimirov ](https://ibob.bg/ ) discusses using HTML5 in the web browser as GUI at the [C++ Conference 2019 (_YouTube_) ](https://www.youtube.com/watch?v=bbbcZd4cuxg ).
WebUI v2.0.7
* Switch from GPL to LGPL
* Deno example is ready
* Adding `void _webui_free_all_mem()` to release all dynamic mem at exit
* Break Change `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char* data)` to `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char** data)`
* Updating readme
* Moving Zig build file into build folder
More code cleaning and more examples is needed before we release the version 2.0.7.
2023-03-21 18:47:19 -04:00
2023-07-24 20:31:17 +02:00
< div align = "center" >
2023-09-05 19:35:02 +02:00
WebUI v2.0.7
* Switch from GPL to LGPL
* Deno example is ready
* Adding `void _webui_free_all_mem()` to release all dynamic mem at exit
* Break Change `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char* data)` to `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char** data)`
* Updating readme
* Moving Zig build file into build folder
More code cleaning and more examples is needed before we release the version 2.0.7.
2023-03-21 18:47:19 -04:00
2023-07-24 20:31:17 +02:00
< / div >
2022-11-02 21:43:48 -04:00
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.
2023-08-21 23:06:46 +02:00
### Why Use Web Browsers?
2022-11-02 21:43:48 -04:00
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.
2023-08-21 23:06:46 +02:00
### How Does it Work?
2022-10-30 15:29:10 -04:00
2023-07-24 20:31:17 +02:00
< div align = "center" >
2023-09-05 19:35:02 +02:00
2022-10-30 15:29:10 -04:00
2023-07-24 20:31:17 +02:00
< / div >
WebUI v2.1.0
#New Features
* Supporting more web browsers
* Search for web browsers in Windows Reg.
* Using the same show() function for HTML script, files, and refresh content
* Support Chrome on macOS
#Breaking code
* Switching from `webui_show(win, html, browser);` to `webui_show(win, content);`, and it's used for HTML, files, and reload the window
* Removing `webui_show_cpy()`, `webui_refresh()`, `webui_refresh_cpy()`
2023-03-28 23:00:09 -04:00
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** .
WebUI v2.0.7
* Switch from GPL to LGPL
* Deno example is ready
* Adding `void _webui_free_all_mem()` to release all dynamic mem at exit
* Break Change `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char* data)` to `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char** data)`
* Updating readme
* Moving Zig build file into build folder
More code cleaning and more examples is needed before we release the version 2.0.7.
2023-03-21 18:47:19 -04:00
2023-08-21 23:06:46 +02:00
### Runtime Dependencies Comparison
WebUI v2.0.7
* Switch from GPL to LGPL
* Deno example is ready
* Adding `void _webui_free_all_mem()` to release all dynamic mem at exit
* Break Change `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char* data)` to `void webui_script_interface(webui_window_t* win, const char* script, unsigned int timeout, bool* error, unsigned int* length, char** data)`
* Updating readme
* Moving Zig build file into build folder
More code cleaning and more examples is needed before we release the version 2.0.7.
2023-03-21 18:47:19 -04:00
2024-07-07 14:20:04 -04:00
| | Tauri / WebView | Qt | WebUI |
2023-10-08 03:01:02 +02:00
| ------------------------------- | ----------------- | -------------------------- | ------------------- |
| 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_** |
2021-03-20 19:53:42 -03:00
2022-11-07 23:33:03 -05:00
## Documentation
2023-08-22 04:20:17 +02:00
> **Note**
> We are currently writing documentation.
2025-02-28 10:48:33 -05:00
- [Online Documentation ](https://webui.me/docs/ )
2022-11-07 23:33:03 -05:00
2025-02-28 10:48:33 -05:00
## Build WebUI Library
2022-09-29 13:46:24 -03:00
2025-03-05 15:49:18 -05:00
### Windows
2023-10-08 03:01:02 +02:00
2025-03-05 15:49:18 -05:00
| Compiler | Command |
|----------|---------|
| GCC | `mingw32-make` |
| MSVC | `nmake` |
2023-10-25 20:17:29 -04:00
2025-03-05 15:49:18 -05:00
< details >
< summary > < strong > Windows SSL/TLS (Optional)< / strong > < / summary >
2023-10-26 19:00:23 -04:00
Download and install the OpenSSL pre-compiled binaries for Windows:
2023-10-27 06:26:54 +02:00
2025-03-05 15:49:18 -05:00
- **MSVC**: [x64 OpenSSL v3.3.1 ](https://slproweb.com/download/Win64OpenSSL-3_3_1.msi ) or [_32Bit_ ](https://slproweb.com/download/Win32OpenSSL-3_3_1.msi ). See the [Wiki list ](https://wiki.openssl.org/index.php/Binaries ) for more info.
- **MinGW**: [Curl for Windows with OpenSSL ](https://curl.se/windows/ )
2023-10-25 20:17:29 -04:00
```powershell
# GCC
2023-10-26 19:00:23 -04:00
mingw32-make WEBUI_USE_TLS=1 WEBUI_TLS_INCLUDE="C:\curl-xxx-xxx-mingw\curl-xxx-xxx-mingw\include" WEBUI_TLS_LIB="C:\curl-xxx-xxx-mingw\curl-xxx-xxx-mingw\lib"
2023-10-25 20:17:29 -04:00
# MSVC
2023-10-26 19:00:23 -04:00
nmake WEBUI_USE_TLS=1 WEBUI_TLS_INCLUDE="C:\Program Files\OpenSSL-xxx\include" WEBUI_TLS_LIB="C:\Program Files\OpenSSL-xxx\lib"
2023-10-25 20:17:29 -04:00
```
2025-03-05 15:49:18 -05:00
< / details >
2023-10-25 20:17:29 -04:00
2025-03-05 15:49:18 -05:00
### Linux
2023-10-08 03:01:02 +02:00
2025-03-05 15:49:18 -05:00
| Compiler | Command |
|----------|---------|
| GCC | `make` |
| Clang | `make CC=clang` |
2023-10-25 20:17:29 -04:00
2025-03-05 15:49:18 -05:00
< details >
< summary > < strong > Linux SSL/TLS (Optional)< / strong > < / summary >
2023-10-25 20:17:29 -04:00
```sh
sudo apt update
sudo apt install libssl-dev
# GCC
make WEBUI_USE_TLS=1
# Clang
make WEBUI_USE_TLS=1 CC=clang
```
2025-03-05 15:49:18 -05:00
< / details >
2023-10-25 20:17:29 -04:00
2025-03-05 15:49:18 -05:00
### macOS
2022-09-29 13:46:24 -03:00
2025-03-05 15:49:18 -05:00
| Compiler | Command |
|----------|---------|
| Default | `make` |
2023-10-25 20:17:29 -04:00
2025-03-05 15:49:18 -05:00
< details >
< summary > < strong > macOS SSL/TLS (Optional)< / strong > < / summary >
2023-10-25 20:17:29 -04:00
```sh
brew install openssl
make WEBUI_USE_TLS=1
```
2025-03-05 15:49:18 -05:00
< / details >
2023-10-25 20:17:29 -04:00
2025-02-28 10:48:33 -05:00
## Minimal WebUI Application
2022-09-29 13:46:24 -03:00
2025-02-28 10:48:33 -05:00
- **C**
```c
#include "webui.h"
int main() {
size_t my_window = webui_new_window();
webui_show(my_window, "< html >< head >< script src = \"webui.js \"></ script ></ head > Hello World ! </ html > ");
webui_wait();
return 0;
}
```
- **C++**
```cpp
#include "webui.hpp"
#include < iostream >
int main() {
webui::window my_window;
my_window.show("< html >< head >< script src = \"webui.js \"></ script ></ head > C++ Hello World ! </ html > ");
webui::wait();
return 0;
}
```
- **More C/C++ Examples**
- [C ](https://github.com/webui-dev/webui/tree/main/examples/C )
- [C++ ](https://github.com/webui-dev/webui/tree/main/examples/C++ )
- **Other Languages**
- [Wrappers List ](#Wrappers )
## Build WebUI Application
2025-03-05 15:49:18 -05:00
### Windows
2025-02-28 10:48:33 -05:00
2025-03-05 15:49:18 -05:00
| Compiler | Type | Command |
|----------|--------|---------|
| GCC | Static | `gcc -Os -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lws2_32 -Wall -luser32 -static -lole32 -o my_application.exe` |
| GCC | Dynamic | `gcc -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "webui-2.dll" -lws2_32 -Wall -luser32 -lole32 -o my_application.exe` |
| MSVC | Static | `cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2-static.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe` |
| MSVC | Dynamic | `cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe` |
2025-02-28 10:48:33 -05:00
2025-03-05 15:49:18 -05:00
< details >
< summary > < strong > Windows With SSL/TLS (Optional)< / strong > < / summary >
2025-02-28 10:48:33 -05:00
2025-03-05 15:49:18 -05:00
| Compiler | Type | Command |
|----------|--------|---------|
| GCC | Static | `gcc -Os -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lws2_32 -Wall -luser32 -static -lole32 -o my_application.exe` |
| GCC | Dynamic | `gcc -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "webui-2-secure.dll" -lws2_32 -Wall -luser32 -lole32 -o my_application.exe` |
| MSVC | Static | `cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2-secure-static.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe` |
| MSVC | Dynamic | `cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2-secure.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe` |
< / details >
### Linux
| Compiler | Type | Command |
|----------|--------|---------|
| GCC | Static | `gcc -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application` |
| GCC | Dynamic | `gcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.so" -lpthread -lm -ldl -o my_application` |
| Clang | Static | `clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application` |
| Clang | Dynamic | `clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.so" -lpthread -lm -ldl -o my_application` |
< details >
< summary > < strong > Linux With SSL/TLS (Optional)< / strong > < / summary >
2025-02-28 10:48:33 -05:00
2025-03-05 15:49:18 -05:00
| Compiler | Type | Command |
|----------|--------|---------|
| GCC | Static | `gcc -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -ldl -o my_application` |
| GCC | Dynamic | `gcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.so" -lpthread -lm -ldl -o my_application` |
| Clang | Static | `clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -ldl -o my_application` |
| Clang | Dynamic | `clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.so" -lpthread -lm -ldl -o my_application` |
< / details >
### macOS
| Compiler | Type | Command |
|----------|--------|---------|
| Clang | Static | `clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -framework Cocoa -framework WebKit -o my_application` |
| Clang | Dynamic | `clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.dylib" -lpthread -lm -framework Cocoa -framework WebKit -o my_application` |
< details >
< summary > < strong > macOS With SSL/TLS (Optional)< / strong > < / summary >
2025-02-28 10:48:33 -05:00
2025-03-05 15:49:18 -05:00
| Compiler | Type | Command |
|----------|--------|---------|
| Clang | Static | `clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -framework Cocoa -framework WebKit -o my_application` |
| Clang | Dynamic | `clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.dylib" -lpthread -lm -framework Cocoa -framework WebKit -o my_application` |
< / details >
2023-05-13 10:47:42 -04:00
2023-08-21 23:06:46 +02:00
## Wrappers
2022-09-29 13:46:24 -03:00
2024-07-07 14:20:04 -04:00
| Language | v2.4.0 API | v2.5.0 API | Link |
| --------------- | --- | -------------- | --------------------------------------------------------- |
| Python | ✔️ | _not complete_ | [Python-WebUI ](https://github.com/webui-dev/python-webui ) |
| Go | ✔️ | _not complete_ | [Go-WebUI ](https://github.com/webui-dev/go-webui ) |
| Zig | ✔️ | _not complete_ | [Zig-WebUI ](https://github.com/webui-dev/zig-webui ) |
| Nim | ✔️ | _not complete_ | [Nim-WebUI ](https://github.com/webui-dev/nim-webui ) |
| V | ✔️ | _not complete_ | [V-WebUI ](https://github.com/webui-dev/v-webui ) |
| Rust | _not complete_ | _not complete_ | [Rust-WebUI ](https://github.com/webui-dev/rust-webui ) |
| TS / JS (Deno) | ✔️ | _not complete_ | [Deno-WebUI ](https://github.com/webui-dev/deno-webui ) |
| TS / JS (Bun) | _not complete_ | _not complete_ | [Bun-WebUI ](https://github.com/webui-dev/bun-webui ) |
| Swift | _not complete_ | _not complete_ | [Swift-WebUI ](https://github.com/webui-dev/swift-webui ) |
| Odin | _not complete_ | _not complete_ | [Odin-WebUI ](https://github.com/webui-dev/odin-webui ) |
| Pascal | _not complete_ | _not complete_ | [Pascal-WebUI ](https://github.com/webui-dev/pascal-webui ) |
| Purebasic | _not complete_ | _not complete_ | [Purebasic-WebUI ](https://github.com/webui-dev/purebasic-webui )|
| - | | |
| Common Lisp | _not complete_ | _not complete_ | [cl-webui ](https://github.com/garlic0x1/cl-webui ) |
| Delphi | _not complete_ | _not complete_ | [WebUI4Delphi ](https://github.com/salvadordf/WebUI4Delphi ) |
| C# | _not complete_ | _not complete_ | [WebUI4CSharp ](https://github.com/salvadordf/WebUI4CSharp ) |
| WebUI.NET | _not complete_ | _not complete_ | [WebUI.NET ](https://github.com/Juff-Ma/WebUI.NET ) |
| QuickJS | _not complete_ | _not complete_ | [QuickUI ](https://github.com/xland/QuickUI ) |
2024-08-20 16:33:18 +08:00
| PHP | _not complete_ | _not complete_ | [PHPWebUiComposer ](https://github.com/KingBes/php-webui-composer ) |
2023-08-21 23:06:46 +02:00
## Supported Web Browsers
2023-10-08 03:01:02 +02:00
| 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_ |
2021-03-20 19:53:42 -03:00
2024-05-27 16:19:00 -04:00
## Supported WebView
| WebView | Status |
| --------------- | --------------- |
| Windows WebView2 | ✔️ |
| Linux GTK WebView | ✔️ |
| macOS WKWebView | ✔️ |
2021-03-20 19:53:42 -03:00
### License
2023-05-04 21:41:03 -04:00
> Licensed under MIT License.
2023-03-26 22:21:38 -04:00
2022-10-20 23:50:17 -03:00
### Stargazers
2023-05-13 10:47:42 -04:00
[](https://github.com/webui-dev/webui/stargazers)
