Skip to content

Repository files navigation

Logo

WebUI v2.5.0-beta.4

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.

Screenshot

Screenshot

Screenshot

GPT

Ask AI Any Question About the WebUI

Download

Contents

Features

  • Portable (Needs only a web browser or a WebView at runtime)
  • One header file
  • Lightweight (Few Kb library) & Small memory footprint
  • Fast binary communication protocol
  • Multi-platform & Multi-Browser
  • Using private profile for safety
  • Cross-platform WebView

UI & The Web Technologies

Borislav Stanimirov discusses using HTML5 in the web browser as GUI at the C++ Conference 2019 (YouTube).

CPPCon

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 Browsers?

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?

Diagram

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 / WebViewQtWebUI
Runtime Dependencies on WindowsWebView2QtCore, QtGui, QtWidgetsA Web Browser
Runtime Dependencies on LinuxGTK3, WebKitGTKQtCore, QtGui, QtWidgetsA Web Browser
Runtime Dependencies on macOSCocoa, WebKitQtCore, QtGui, QtWidgetsA Web Browser

Documentation

Note We are currently writing documentation.

Build WebUI Library

Windows

CompilerCommand
GCCmingw32-make
MSVCnmake
Windows SSL/TLS (Optional)

Download and install the OpenSSL pre-compiled binaries for Windows:

# GCC
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"# MSVC
nmake WEBUI_USE_TLS=1 WEBUI_TLS_INCLUDE="C:\Program Files\OpenSSL-xxx\include" WEBUI_TLS_LIB="C:\Program Files\OpenSSL-xxx\lib"

Linux

CompilerCommand
GCCmake
Clangmake CC=clang
Linux SSL/TLS (Optional)
sudo apt update
sudo apt install libssl-dev
# GCC
make WEBUI_USE_TLS=1
# Clang
make WEBUI_USE_TLS=1 CC=clang

macOS

CompilerCommand
Defaultmake
macOS SSL/TLS (Optional)
brew install openssl
make WEBUI_USE_TLS=1

Minimal WebUI Application

  • C

    #include"webui.h"intmain() {
    size_tmy_window=webui_new_window();
    webui_show(my_window, "<html><head><script src=\"webui.js\"></script></head> Hello World ! </html>");
    webui_wait();
    return0;
    }
  • C++

    #include"webui.hpp"
    #include<iostream>intmain() {
    webui::window my_window;
    my_window.show("<html><head><script src=\"webui.js\"></script></head> C++ Hello World ! </html>");
    webui::wait();
    return0;
    }
  • More C/C++ Examples

  • Other Languages

Build WebUI Application

Windows

CompilerTypeCommand
GCCStaticgcc -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 -lstdc++ -luuid -o my_application.exe
GCCDynamicgcc -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 -lstdc++ -luuid my_application.exe
MSVCStaticcl 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
MSVCDynamiccl 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
Windows With SSL/TLS (Optional)
CompilerTypeCommand
GCCStaticgcc -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 -lstdc++ -luuid -o my_application.exe
GCCDynamicgcc -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 -lstdc++ -luuid -o my_application.exe
MSVCStaticcl 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
MSVCDynamiccl 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

Linux

CompilerTypeCommand
GCCStaticgcc -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application
GCCDynamicgcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2 -lpthread -lm -ldl -o my_application
ClangStaticclang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application
ClangDynamicclang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2 -lpthread -lm -ldl -o my_application
Linux With SSL/TLS (Optional)
CompilerTypeCommand
GCCStaticgcc -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -ldl -o my_application
GCCDynamicgcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure -lpthread -lm -ldl -o my_application
ClangStaticclang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -ldl -o my_application
ClangDynamicclang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure -lpthread -lm -ldl -o my_application

macOS

CompilerTypeCommand
ClangStaticclang -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
ClangDynamicclang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2 -lpthread -lm -framework Cocoa -framework WebKit -o my_application
macOS With SSL/TLS (Optional)
CompilerTypeCommand
ClangStaticclang -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
ClangDynamicclang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure -lpthread -lm -framework Cocoa -framework WebKit -o my_application

Wrappers

Languagev2.4.0 APIv2.5.0 APILink
Python✔️not completePython-WebUI
Go✔️not completeGo-WebUI
Zig✔️not completeZig-WebUI
Nim✔️not completeNim-WebUI
V✔️not completeV-WebUI
Rustnot completenot completeRust-WebUI
TS / JS (Deno)✔️not completeDeno-WebUI
TS / JS (Bun)not completenot completeBun-WebUI
Swiftnot completenot completeSwift-WebUI
Odinnot completenot completeOdin-WebUI
Pascalnot completenot completePascal-WebUI
Purebasicnot completenot completePurebasic-WebUI
-
Common Lispnot completenot completecl-webui
Delphinot completenot completeWebUI4Delphi
C#not completenot completeWebUI4CSharp
WebUI.NETnot completenot completeWebUI.NET
QuickJSnot completenot completeQuickUI
PHPnot completenot completePHPWebUiComposer

Supported Web Browsers

BrowserWindowsmacOSLinux
Mozilla Firefox✔️✔️✔️
Google Chrome✔️✔️✔️
Microsoft Edge✔️✔️✔️
Chromium✔️✔️✔️
Yandex✔️✔️✔️
Brave✔️✔️✔️
Vivaldi✔️✔️✔️
Epic✔️✔️not available
Apple Safarinot availablecoming soonnot available
Operacoming sooncoming sooncoming soon

Supported WebView

WebViewStatus
Windows WebView2✔️
Linux GTK WebView✔️
macOS WKWebView✔️

License

Licensed under MIT License.

Stargazers

Stargazers repo roster for @webui-dev/webui

About

Use any web browser as GUI, with your preferred language in the backend and HTML5 in the frontend, all in a lightweight portable lib.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages