V-WebUI

Features · Installation · Usage · Documentation · WebUI

Use any web browser or WebView as GUI.
With V in the backend and modern web technologies in the frontend.

Features

Parent library written in pure C
Fully Independent (No need for any third-party runtimes)
Lightweight ~200 Kb & Small memory footprint
Fast binary communication protocol between WebUI and the browser (Instead of JSON)
Multi-platform & Multi-Browser
Using private profile for safety

Installation

v install https://github.com/webui-dev/v-webui

Usage

Note

It is recommended to use GCC or Clang to compile a WebUI V program. TCC is currently not working due to missing header files. E.g.:

v -cc gcc run .

Example

import vwebui as ui

const html = '<!DOCTYPE html>
<html>
   <head>
      <script src="webui.js"></script>
      <style>
         body {
            background: linear-gradient(to left, #36265a, #654da9);
            color: AliceBlue;
            font: 16px sans-serif;
            text-align: center;
            margin-top: 30px;
         }
      </style>
   </head>
   <body>
      <h1>Welcome to WebUI!</h1>
      <br>
      <input type="text" id="name" value="Neo">
      <button onclick="handleVResponse();">Call V</button>
      <br>
      <br>
      <div><samp id="greeting"></samp></div>
      <script>
         async function handleVResponse() {
            const inputName = document.getElementById("name");
            const result = await webui.greet(inputName.value);
            document.getElementById("greeting").innerHTML = result;
         }
      </script>
   </body>
</html>'

fn greet(e &ui.Event) string {
	name := e.get_arg[string]() or { panic('expected an argument') }
	println('${name} has reached the backend!')
	return 'Hello ${name} 🐇'
}

fn main() {
	mut w := ui.new_window()
	w.bind('greet', greet)
	w.show(html)!
	ui.wait()
}

Find more examples in the examples/ directory.

Documentation

Online Documentation (WIP)

Tip

Until our online documentation is finished, you can refer to src/lib.v or use V's built-in v doc -comments vwebui in the terminal for the latest overview of exported functions.

To use WebUI's debug build in your V-WebUI application, add the -d debug flag. E.g.:
```
v -d webui_log run examples/call_v_from_js.v
```
Run tests locally:
```
VJOBS=1 v -stats test tests/
```

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

License

Licensed under the MIT License.

Compile time error

I tried to compile text-editor.v, but got a compile time error.

v text-editor.v

==================
.../v_0/text-editor.3556100730162151181.tmp.c:13996: warning: assignment discards qualifiers from pointer target type
.../v_0/text-editor.3556100730162151181.tmp.c:14074: error: macro 'ADDR' used with too many args
...
==================
(Use `v -cg` to print the entire error message)
builder error:
==================
C error. This should never happen.
This is a compiler bug, please report it using `v bug file.v`.
https://github.com/vlang/v/issues/new/choose
You can also use #help on Discord: https://discord.gg/vlang

text-editor.3556100730162151181.tmp.c:13996:

malisipi__vwebui__WebuiResponseData malisipi__vwebui__CEvent_get(malisipi__vwebui__CEvent* e) {
	---> string str = char_vstring(webui_get_string(e));
	malisipi__vwebui__WebuiResponseData _t1 = ((malisipi__vwebui__WebuiResponseData){._v_string = str,._v_int = string_int(str),._v_bool = string__eq(str, _SLIT("true")),});
	return _t1;
}

Info:
The warning is because char_vstring() expect a char* but webui_get_string() is a const char*

text-editor.3556100730162151181.tmp.c:14074:

VV_LOCAL_SYMBOL void malisipi__vwebui__native_event_handler(malisipi__vwebui__CEvent* e) {
	{ // Unsafe block
		u64 bind_id = webui_interface_get_bind_id(e->window, e->element);
		---> malisipi__vwebui__Response resp = ((malisipi__vwebui__Response (*) (malisipi__vwebui__Event* e))(*(voidptr*)map_get(ADDR(map, ADDR(map, function_list), &(u64[]){webui_interface_get_window_id(e->window)}, &(voidptr[]){ new_map_noscan_key(sizeof(u64), sizeof(malisipi__vwebui__Function), &map_hash_int_8, &map_eq_int_8, &map_clone_int_8, &map_free_nop) })))), &(u64[]){bind_id}, &(voidptr[]){ 0 })))(ADDR(malisipi__vwebui__Event/*qq*/, ((malisipi__vwebui__Event){.window = e->window,.event_type = ((malisipi__vwebui__event)(e->event_type)),.element = char_vstring(e->element),.data = malisipi__vwebui__CEvent_get(e),.event_number = e->event_number,})));
		malisipi__vwebui__CEvent_return(e, resp);
	}
}

Debug info:
a value of type "malisipi__vwebui__Response (*)(malisipi__vwebui__Event *e)" cannot be used to initialize an entity of type "malisipi__vwebui__Response"

webui-dev / v-webui Goto Github PK

v-webui's Introduction

V-WebUI

Features · Installation · Usage · Documentation · WebUI

Features

Installation

Usage

Example

Documentation

Supported Web Browsers

License

v-webui's People

Contributors

Stargazers

Watchers

Forkers

v-webui's Issues

Hey there webui-dev!

I was trying to build the program by using this method:

But it gave me this error:

Recommend Projects

Recommend Topics

Recommend Org