WebUI is not a web-server solution or a framework, but it allows you to use any web browser as a GUI, with Nim in the backend and HTML5 in the frontend. All in a lightweight portable lib.
- Fully Independent (No need for any third-party library)
- Lightweight (~600 Kb (300 Kb when compiling with DLL)) & Small memory footprint
- Fast binary communication protocol between WebUI and the browser (Instead of JSON)
- Multi-platform & Multi-Browser
- Using private profile for safety
This text editor example is written in Nim using WebUI as the GUI library.
Install via Nimble:
nimble install webuiOnline documentation can be found here:
- https://webui.me/docs/2.4.0/#/nim_api
- https://neroist.github.io/webui-docs/ (same thing but made in nimib)
There isn't much documentation as of right now, so I suggest to get started using some examples or WebUI's own examples or documentation.
Heres a very minimal example of using the wrapper:
import webui
let window = newWindow() # Create a new Window
window.show("<html>Hello</html>") # Show the window with html content
wait() # Wait until the window gets closedExamples can be found here at examples/.
If you're trying to run the examples remember to clone the repository recursively, as it depends on the WebUI repo as a submodule. Here's the command to do so for the truly lazy:
git clone --recursive https://github.com/neroist/webui.gitThe Nim library exposes two files: webui.nim and webui/bindings.nim.
webui/bindings.nim are low-level bindings for WebUI, generated by
c2nim. webui.nim is a high-level wrapper for
WebUI, using native Nim types and avoiding pointers.
The wrapper and bindings also allow to to control whether or not to statically compile WebUI's C sources into your application, compile with a static library, or to depend on a DLL. Static compilation is the default behavior.
To compile with a static library, pass -d:useWebviewStaticLib or
-d:useWebviewStaticLibrary to the Nim compiler. To depend on a DLL, pass
-d:useWebviewDll instead. If neither of these flags are passed to the Nim
compiler, static compilation will take place instead. Static libraries and DLLs can
be found in WebUI's website here.
In addition, you can also enable WebUI's logging via -d:webuiLog but that flag
only works for static compilation.
| 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 |
MIT License. See LICENSE
Original WebUI library is licensed under MIT. See LICENSE.