-
24 |
-
28 | 29 | 30 | 31 | 32 |33 | 39 |
40 |
68 | 
69 |
70 | Using the file system
71 | ```sh
72 | lua examples/open.lua %CD%\examples\htdocs\todo.html
73 | ```
74 |
75 | 
76 | 
77 |
78 | Pure Lua
79 | ```sh
80 | wlua54 examples/simple.lua
81 | ```
82 |
83 | 
84 | 
85 |
86 | Generic launcher, with helper function to pass JSON objects and more
87 | ```sh
88 | lua examples/launch.lua examples/htdocs/simple.html --wv-event=thread
89 | ```
90 |
91 | ## LuaRocks
92 |
93 | Lua webview can be intalled using LuaRocks
94 |
95 | ### LuaRocks on Linux
96 |
97 | Prerequisites:
98 | ```sh
99 | sudo apt install luarocks lua5.3 lua5.3-dev
100 | sudo apt install libgtk-3-dev libwebkit2gtk-4.0-dev
101 | ```
102 |
103 | ```sh
104 | luarocks install lua-webview --local
105 | ```
106 |
107 | ### LuaRocks on Windows
108 |
109 | Prerequisites:
110 | Download the Lua 64 bits dynamic libraries built with MinGW-w64 from [Lua Binaries](https://sourceforge.net/projects/luabinaries/).
111 | Add [MSYS2](https://www.msys2.org/), MinGW-w64 and [git](https://git-scm.com/) in the path.
112 |
113 |
114 | ```Batchfile
115 | luarocks --lua-dir C:/bin/lua-5.3.5 MAKE=make CC=gcc LD=gcc install lua-webview
116 | ```
117 | Take care to use forward slashes for the Lua path.
118 |
--------------------------------------------------------------------------------
/examples/calc.lua:
--------------------------------------------------------------------------------
1 | local event = require('jls.lang.event')
2 | local File = require('jls.io.File')
3 | local WebView = require('jls.util.WebView')
4 | local FileHttpHandler = require('jls.net.http.handler.FileHttpHandler')
5 | local RestHttpHandler = require('jls.net.http.handler.RestHttpHandler')
6 |
7 | local scriptFile = File:new(arg[0]):getAbsoluteFile()
8 | local scriptDir = scriptFile:getParentFile()
9 | local htdocsDir = File:new(scriptDir, 'htdocs')
10 |
11 | -- localhost ::1 127.0.0.1
12 | WebView.open('http://localhost:0/calc.html', 'Calc', 320, 480, true):next(function(webview)
13 | local httpServer = webview:getHttpServer()
14 | print('WebView opened with HTTP Server bound on address', httpServer:getAddress())
15 | httpServer:createContext('/(.*)', FileHttpHandler:new(htdocsDir))
16 | httpServer:createContext('/rest/(.*)', RestHttpHandler:new({
17 | ['calculate(requestJson)?method=POST&content-type=application/json'] = function(exchange, requestJson)
18 | local f, err = load('return '..tostring(requestJson.line))
19 | return {line = f and f() or err or ''}
20 | end
21 | }))
22 | return webview:getThread():ended()
23 | end):next(function()
24 | print('WebView closed')
25 | end):catch(function(err)
26 | print('Cannot open webview due to '..tostring(err))
27 | end)
28 |
29 | --print('Looping')
30 | event:loop()
31 | event:close()
32 |
--------------------------------------------------------------------------------
/examples/htdocs/FileChooser.css:
--------------------------------------------------------------------------------
1 | .file-chooser-dialog {
2 | display: flex;
3 | flex-direction: column;
4 | }
5 | .file-chooser-content {
6 | flex-grow: 1;
7 | }
8 | .file-chooser-flex-row {
9 | min-width: 100%;
10 | display: flex;
11 | flex-direction: row;
12 | }
13 | .file-chooser-flex-row > * {
14 | margin-top: auto;
15 | margin-bottom: auto;
16 | }
17 | .file-chooser-flex-row-content {
18 | flex-grow: 1;
19 | }
20 | .file-chooser-footer.file-chooser-flex-row {
21 | justify-content: flex-end;
22 | }
23 | .file-chooser-dialog ul {
24 | list-style-type: none;
25 | }
26 | .file-chooser-directory {
27 | text-decoration: underline;
28 | }
29 |
--------------------------------------------------------------------------------
/examples/htdocs/FileChooser.js:
--------------------------------------------------------------------------------
1 | (function() {
2 |
3 | function directoryFirst(fa, fb) {
4 | var da = fa.isDirectory;
5 | var db = fb.isDirectory;
6 | return da === db ? 0 : (da ? -1 : 1);
7 | }
8 |
9 | function filterFiles(files, showAll, contains) {
10 | var containsLowerCase = contains && contains.toLowerCase();
11 | return files.filter(function(file) {
12 | if (!showAll && file.name.charAt(0) === '.' && file.name !== '..') {
13 | return false;
14 | }
15 | return file.isDirectory || !containsLowerCase || file.name.toLowerCase().indexOf(containsLowerCase) >= 0;
16 | })
17 | }
18 |
19 | function fileList(path, useFetch, callback) {
20 | if (useFetch) {
21 | if (webview && webview.fileList) {
22 | webview.fileList(path, callback);
23 | } else {
24 | callback('webview.fileList is not available');
25 | }
26 | } else {
27 | fetch('rest/listFiles', {
28 | method: 'POST',
29 | headers: {
30 | "Content-Type": "text/plain"
31 | },
32 | body: path
33 | }).then(function(response) {
34 | return response.json();
35 | }).then(function(list) {
36 | callback(null, list);
37 | }, function(reason) {
38 | callback(reason || 'Unknown error');
39 | });
40 | }
41 | }
42 |
43 | var FileChooserDialog = Vue.component('file-chooser-dialog', {
44 | template: '| 29 | | 30 | | 31 | | 32 | |
| 35 | | 36 | | 37 | | 38 | |
| 41 | | 42 | | 43 | | 44 | |
| 47 | | 48 | | 49 | | 50 | |
| 53 | | 54 | | 55 | | 56 | |
This example shows how to choose a file to operate using Lua.
37 |{{ filename }}
44 |Initializing...
9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 |Print Lua:
19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |Windows ({{ list.length }})
19 | 20 | 26 | 🔍 27 | 28 |You could specify an URL to open as a command line argument.
7 | 8 | 9 | ]] 10 | 11 | -- Parse command line arguments 12 | local urlArg = arg[1] 13 | if urlArg and urlArg ~= '' then 14 | if urlArg == '-h' or urlArg == '/?' or urlArg == '--help' then 15 | print('Opens a WebView using the specified URL') 16 | print('Optional arguments: url title width height resizable') 17 | os.exit(0) 18 | end 19 | local protocol = string.match(urlArg, '^([^:]+):.+$') 20 | if protocol == 'http' or protocol == 'https' or protocol == 'file' or protocol == 'data' then 21 | url = urlArg 22 | elseif string.match(urlArg, '^.:\\.+$') or string.match(urlArg, '^/.+$') then 23 | url = 'file://'..tostring(urlArg) 24 | else 25 | print('Invalid URL, to open a file please use an absolute path') 26 | os.exit(22) 27 | end 28 | end 29 | local title = arg[2] or 'Web View' 30 | local width = arg[3] or 800 31 | local height = arg[4] or 600 32 | local resizable = arg[5] ~= 'false' 33 | 34 | -- Opens the web view 35 | require('webview').open(url, title, width, height, resizable) 36 | -------------------------------------------------------------------------------- /examples/simple.lua: -------------------------------------------------------------------------------- 1 | local webviewLib = require('webview') 2 | 3 | local content = [[ 4 | 5 | 6 |It works !
7 | 8 | 9 | 10 | 11 |You could specify an HTML file to launch as a command line argument.
462 | 463 | 464 | 465 | ]]) 466 | 467 | local title 468 | local width = 800 469 | local height = 600 470 | local resizable = true 471 | local debug = false 472 | local eventMode = nil 473 | local initialize = true 474 | local luaScript = true 475 | local captureError = true 476 | local luaPath = false 477 | 478 | -- Parse command line arguments 479 | args = args or arg or {} 480 | local ctxArgs = {} 481 | local luaSrcPath = nil 482 | local urlArg 483 | 484 | for i = 1, #args do 485 | local name, value = string.match(args[i], '^%-%-wv%-([^=]+)=?(.*)$') 486 | if not name then 487 | if urlArg then 488 | table.insert(ctxArgs, args[i]) 489 | else 490 | urlArg = args[i] 491 | end 492 | elseif name == 'size' and value then 493 | local w, h = string.match(value, '^(%d+)[xX-/](%d+)$') 494 | width = tonumber(w) 495 | height = tonumber(h) 496 | elseif name == 'title' and value then 497 | title = value 498 | elseif name == 'width' and tonumber(value) then 499 | width = tonumber(value) 500 | elseif name == 'height' and tonumber(value) then 501 | height = tonumber(value) 502 | elseif name == 'resizable' then 503 | resizable = value ~= 'false' 504 | elseif name == 'debug' then 505 | debug = value == 'true' 506 | elseif name == 'event' and (value == 'open' or value == 'main' or value == 'thread' or value == 'http') then 507 | eventMode = value 508 | elseif name == 'initialize' then 509 | initialize = value ~= 'false' 510 | elseif name == 'script' then 511 | luaScript = value ~= 'false' 512 | elseif name == 'captureError' then 513 | captureError = value ~= 'false' 514 | elseif name == 'luaPath' then 515 | luaPath = value == 'true' 516 | else 517 | print('Invalid argument', args[i]) 518 | os.exit(22) 519 | end 520 | end 521 | 522 | -- Process URL argument 523 | if urlArg and urlArg ~= '' then 524 | if urlArg == '-h' or urlArg == '/?' or urlArg == '--help' then 525 | print('Launchs a WebView using the specified URL') 526 | print('Optional arguments: url --wv-title= --wv-width='..tostring(width)..' --wv-height='..tostring(height)..' --wv-resizable='..tostring(resizable)) 527 | os.exit(0) 528 | end 529 | local protocol = string.match(urlArg, '^([^:]+):.+$') 530 | if protocol == 'http' or protocol == 'https' or protocol == 'file' or protocol == 'data' then 531 | url = urlArg 532 | else 533 | local filePath 534 | if string.match(urlArg, '^.:\\.+$') or string.match(urlArg, '^/.+$') then 535 | filePath = urlArg 536 | elseif fsLib then 537 | filePath = fsLib.currentdir()..fileSeparator..urlArg 538 | end 539 | if not filePath then 540 | print('Invalid URL, to launch a file please use an absolute path') 541 | os.exit(22) 542 | end 543 | luaSrcPath = string.match(filePath, '^(.*)[/\\][^/\\]+$') 544 | url = 'file://'..filePath 545 | end 546 | end 547 | 548 | if luaSrcPath and luaPath then 549 | package.path = package.path..';'..luaSrcPath..'/?.lua' 550 | end 551 | 552 | return url, { 553 | title = title or 'Web View', 554 | width = width, 555 | height = height, 556 | resizable = resizable, 557 | debug = debug 558 | }, { 559 | eventMode = eventMode, 560 | initialize = initialize, 561 | useJsTitle = not title, 562 | luaScript = luaScript, 563 | luaPath = luaPath, 564 | captureError = captureError, 565 | context = { 566 | args = ctxArgs, 567 | luaSrcPath = luaSrcPath, 568 | }, 569 | } 570 | end 571 | 572 | local function createContextAndPath(wv, opts) 573 | if opts.luaPath and opts.context and opts.context.luaSrcPath then 574 | package.path = package.path..';'..opts.context.luaSrcPath..'/?.lua' 575 | end 576 | return createContext(wv, opts) 577 | end 578 | 579 | local function launchWithOptions(url, wvOptions, options) 580 | wvOptions = wvOptions or {} 581 | options = options or wvOptions 582 | if options.eventMode then 583 | local event = require('jls.lang.event') 584 | local WebView = require('jls.util.WebView') 585 | if options.eventMode == 'thread' then 586 | --webviewLib.open('data:text/html,Close to start', 'Close to start', 320, 200) 587 | WebView.open(url, wvOptions):next(function(webview) 588 | local callback = createContextAndPath(webview._webview, options) 589 | webview:callback(callback) 590 | end) 591 | elseif options.eventMode == 'http' then 592 | if not options.context.luaSrcPath then 593 | error('Please specify a file path as URL') 594 | end 595 | local FileHttpHandler = require('jls.net.http.handler.FileHttpHandler') 596 | options.callback = true 597 | options.contexts = { 598 | ['/(.*)'] = FileHttpHandler:new(options.context.luaSrcPath or '.') 599 | } 600 | local filename = string.match(url, '^.*[/\\]([^/\\]+)$') 601 | WebView.open('http://localhost:0/'..filename, options):next(function(webview) 602 | local callback = createContextAndPath(webview._webview, options) 603 | webview:callback(callback) 604 | end) 605 | else 606 | local open = options.eventMode == 'main' and WebView.openSync or WebView.open 607 | wvOptions.fn = function(webview, data) 608 | local webviewLauncher = require('webview-launcher') 609 | local opts = webviewLauncher.jsonLib.decode(data) 610 | local callback = webviewLauncher.createContextAndPath(webview._webview, opts) 611 | webview:callback(callback) 612 | end 613 | wvOptions.data = jsonLib.encode(options) 614 | open(url, wvOptions) 615 | end 616 | event:loop() 617 | else 618 | local webview = webviewLib.new(url, wvOptions.title, wvOptions.width, wvOptions.height, wvOptions.resizable, wvOptions.debug) 619 | local callback = createContext(webview, options) 620 | webviewLib.callback(webview, callback) 621 | webviewLib.loop(webview) 622 | end 623 | end 624 | 625 | return { 626 | initializeJs = initializeJs, 627 | createContext = createContext, 628 | createContextAndPath = createContextAndPath, 629 | escapeUrl = escapeUrl, 630 | launchFromArgs = function(args, ...) 631 | if type(args) == 'string' then 632 | args = {args, ...} 633 | elseif type(args) ~= 'table' then 634 | args = arg 635 | end 636 | launchWithOptions(parseArgs(args)) 637 | end, 638 | launchWithOptions = launchWithOptions, 639 | jsonLib = jsonLib, 640 | fsLib = fsLib, 641 | } 642 | -------------------------------------------------------------------------------- /webview.c: -------------------------------------------------------------------------------- 1 | #include