Improved window parameter handling

go mod update

.github/workflows/pr.yml

@@ -71,14 +71,28 @@ jobs:
         with:
           go-version: ${{ matrix.go-version }}
 
-      - name: Run tests (mac)
-        if: matrix.os == 'macos-latest'
+      - name: Run tests (mac) | v2
+        if: ${{ matrix.os == 'macos-latest' && github.event.pull_request.base.ref == 'master' }}
         env:
           CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
+          CGO_CFLAGS: -mmacosx-version-min=10.13
         working-directory: ./v2
         run: go test -v ./...
 
-      - name: Run tests (!mac)
-        if: matrix.os != 'macos-latest'
-        working-directory: ./v2
+      - name: Run tests (!mac) | v2
+        if: ${{ matrix.os != 'macos-latest' && github.event.pull_request.base.ref == 'master' }}
+        working-directory:  ./v2
+        run: go test -v ./...
+
+      - name: Run tests (mac) | v3
+        if: ${{ matrix.os == 'macos-latest' && github.event.pull_request.base.ref == 'v3-alpha' }}
+        env:
+          CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
+          CGO_CFLAGS: -mmacosx-version-min=10.13
+        working-directory: ./v3
+        run: go test -v ./...
+
+      - name: Run tests (!mac) | v3
+        if: ${{ matrix.os != 'macos-latest' && github.event.pull_request.base.ref == 'v3-alpha' }}
+        working-directory:  ./v3
         run: go test -v ./...

.github/workflows/publish-npm.yml

@@ -0,0 +1,20 @@
+on:
+  push:
+    branches: ['v3-alpha']
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+      - run: npm ci
+        working-directory: v3/internal/runtime/desktop/@wailsio/runtime
+
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          package: v3/internal/runtime/desktop/@wailsio/runtime
+          access: public
+          token: ${{ secrets.NPM_TOKEN }}

mkdocs-website/docs/en/changelog.md

@@ -31,6 +31,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support multiple space-separated trigger events in the WML system by [@fbbdev](https://github.com/fbbdev) in [#3295](https://github.com/wailsapp/wails/pull/3295)
 - Add ESM exports from the bundled JS runtime script by [@fbbdev](https://github.com/fbbdev) in [#3295](https://github.com/wailsapp/wails/pull/3295)
 - Add binding generator flag for using the bundled JS runtime script instead of the npm package by [@fbbdev](https://github.com/fbbdev) in [#3334](https://github.com/wailsapp/wails/pull/3334)
+- Implement `setIcon` on linux by [@abichinger](https://github.com/abichinger) in [#3354](https://github.com/wailsapp/wails/pull/3354)
+- Add flag `-port` to dev command and support environment variable `WAILS_VITE_PORT` by [@abichinger](https://github.com/abichinger) in [#3429](https://github.com/wailsapp/wails/pull/3429)
+- Add tests for bound method calls by [@abichinger](https://github.com/abichinger) in [#3431](https://github.com/wailsapp/wails/pull/3431)
 
 ### Fixed
 
@@ -56,6 +59,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix custom context menu closing immediately on linux by [@abichinger](https://github.com/abichinger) in [#3330](https://github.com/wailsapp/wails/pull/3330)
 - Fix the output path and extension of model files produced by the binding generator by [@fbbdev](https://github.com/fbbdev) in [#3334](https://github.com/wailsapp/wails/pull/3334)
 - Fix the import paths of model files in JS code produced by the binding generator by [@fbbdev](https://github.com/fbbdev) in [#3334](https://github.com/wailsapp/wails/pull/3334)
+- Fix drag-n-drop on some linux distros by [@abichinger](https://github.com/abichinger) in [#3346](https://github.com/wailsapp/wails/pull/3346)
+- Fix missing task for macOS when using `wails3 task dev` by [@hfoxy](https://github.com/hfoxy) in [#3417](https://github.com/wailsapp/wails/pull/3417)
+- Fix registering events causing a nil map assignment by [@hfoxy](https://github.com/hfoxy) in [#3426](https://github.com/wailsapp/wails/pull/3426)
+- Fix unmarshaling of bound method parameters by [@fbbdev](https://github.com/fbbdev) in [#3431](https://github.com/wailsapp/wails/pull/3431)
+- Fix handling of multiple return values from bound methods by [@fbbdev](https://github.com/fbbdev) in [#3431](https://github.com/wailsapp/wails/pull/3431)
 
 ### Changed
 

mkdocs-website/docs/en/getting-started/feedback.md

@@ -5,7 +5,7 @@ posts before creating new ones. Here are the different ways to provide feedback:
 
 === "Bugs"
 
-    If you find a bug, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel on Discord. 
+    If you find a bug, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/Vgff2p8gsy) channel on Discord. 
     
     - The post should clearly state what the bug is and have a simple reproducible example. If the docs are unclear what *should* happen, please include that in the post.
     - The post should be given the `Bug` tag.
@@ -24,17 +24,17 @@ posts before creating new ones. Here are the different ways to provide feedback:
     If you have a fix for a bug or an update for documentation, please do the following:
 
     - Open a pull request on the [Wails repository](https://github.com/wailsapp/wails). The title of the PR should start with `[v3 alpha]`.
-    - Create a post in the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel.
+    - Create a post in the [v3 Alpha Feedback](https://discord.gg/Vgff2p8gsy) channel.
     - The post should be given the `PR` tag.
     - Please include a link to the PR in your post.
 
 === "Suggestions"
 
-    If you have a suggestion, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel on Discord:
+    If you have a suggestion, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/Vgff2p8gsy) channel on Discord:
 
     - The post should be given the `Suggestion` tag.
 
-    Please feel free to reach out to us on [Discord](https://discord.gg/3mgVyGua) if you have any questions.
+    Please feel free to reach out to us on [Discord](https://discord.gg/Vgff2p8gsy) if you have any questions.
 
 === "Upvoting"
 

mkdocs-website/docs/en/learn/plugins.md

@@ -0,0 +1,176 @@
+# Wails v3 Plugin Guide
+
+Wails v3 introduces the concept of plugins. A plugin is a self-contained module that can extend the functionality of your Wails application. 
+This guide will walk you through the structure and functionality of a Wails plugin.
+
+## Plugin Structure
+
+A Wails plugin is a standard Go module, typically consisting of the following files:
+
+- `plugin.go`: This is the main Go file where the plugin's functionality is implemented.
+- `plugin.yaml`: This is the plugin's metadata file. It contains information about the plugin such as its name, author, version, and more.
+- `assets/`: This directory contains any static assets that the plugin might need.
+- `README.md`: This file provides documentation for the plugin.
+
+## Plugin Implementation
+
+In `plugin.go`, a plugin is defined as a struct that implements the `application.Plugin` interface. This interface requires the following methods:
+
+- `Init()`: This method is called when the plugin is initialized.
+- `Shutdown()`: This method is called when the application is shutting down.
+- `Name()`: This method returns the name of the plugin.
+- `CallableByJS()`: This method returns a list of method names that can be called from the frontend.
+
+In addition to these methods, you can define any number of additional methods that implement the plugin's functionality. 
+These methods can be called from the frontend using the `wails.Plugin()` function.
+
+## Plugin Metadata
+
+The `plugin.yaml` file contains metadata about the plugin. This includes the plugin's name, description, author, version, website, repository, and license.
+
+## Plugin Assets
+
+Any static assets that the plugin needs can be placed in the `assets/` directory. 
+These assets can be accessed by the frontend by requesting them at the plugin base path.
+This path is `/wails/plugins/<plugin-name>/`.
+
+### Example
+
+If a plugin named `logopack` has an asset named `logo.png`, the frontend can access it at `/wails/plugins/logopack/logo.png`.
+
+## Plugin Documentation
+
+The `README.md` file provides documentation for the plugin. This should include instructions on how to install and use the plugin, as well as any other information that users of the plugin might find useful.
+
+## Example
+
+Here's the Log plugin implementation:
+
+```go
+package log
+
+import (
+	"embed"
+	_ "embed"
+	"github.com/wailsapp/wails/v3/pkg/application"
+	"io/fs"
+	"log/slog"
+)
+
+//go:embed assets/*
+var assets embed.FS
+
+// ---------------- Plugin Setup ----------------
+// This is the main plugin struct. It can be named anything you like.
+// It must implement the application.Plugin interface.
+// Both the Init() and Shutdown() methods are called synchronously when the app starts and stops.
+
+type Config struct {
+	// Logger is the logger to use. If not set, a default logger will be used.
+	Logger *slog.Logger
+
+	// LogLevel defines the log level of the logger.
+	LogLevel slog.Level
+
+	// Handles errors that occur when writing to the log
+	ErrorHandler func(err error)
+}
+
+type Plugin struct {
+	config *Config
+	app    *application.App
+	level  slog.LevelVar
+}
+
+func NewPluginWithConfig(config *Config) *Plugin {
+	if config.Logger == nil {
+		config.Logger = application.DefaultLogger(config.LogLevel)
+	}
+
+	result := &Plugin{
+		config: config,
+	}
+	result.level.Set(config.LogLevel)
+	return result
+}
+
+func NewPlugin() *Plugin {
+	return NewPluginWithConfig(&Config{})
+}
+
+// Shutdown is called when the app is shutting down
+// You can use this to clean up any resources you have allocated
+func (p *Plugin) Shutdown() error { return nil }
+
+// Name returns the name of the plugin.
+// You should use the go module format e.g. github.com/myuser/myplugin
+func (p *Plugin) Name() string {
+	return "github.com/wailsapp/wails/v3/plugins/log"
+}
+
+func (p *Plugin) Init(api application.PluginAPI) error {
+	return nil
+}
+
+// CallableByJS returns a list of methods that can be called from the frontend
+func (p *Plugin) CallableByJS() []string {
+	return []string{
+		"Debug",
+		"Info",
+		"Warning",
+		"Error",
+		"SetLogLevel",
+	}
+}
+
+func (p *Plugin) Assets() fs.FS {
+	return assets
+}
+
+// ---------------- Plugin Methods ----------------
+// Plugin methods are just normal Go methods. You can add as many as you like.
+// The only requirement is that they are exported (start with a capital letter).
+// You can also return any type that is JSON serializable.
+// See https://golang.org/pkg/encoding/json/#Marshal for more information.
+
+func (p *Plugin) Debug(message string, args ...any) {
+	p.config.Logger.Debug(message, args...)
+}
+
+func (p *Plugin) Info(message string, args ...any) {
+	p.config.Logger.Info(message, args...)
+}
+
+func (p *Plugin) Warning(message string, args ...any) {
+	p.config.Logger.Warn(message, args...)
+}
+
+func (p *Plugin) Error(message string, args ...any) {
+	p.config.Logger.Error(message, args...)
+}
+
+func (p *Plugin) SetLogLevel(level slog.Level) {
+	p.level.Set(level)
+}
+
+```
+
+This plugin can be added to the application like this:
+
+```go
+    Plugins: map[string]application.Plugin{
+        "log": log.NewPlugin(),
+    },
+```
+And here's how you can call a plugin method from the frontend:
+
+```js
+    wails.Plugin("log","Debug","hello world")
+```
+
+## Support
+
+If you encounter any issues with a plugin, please raise a ticket in the plugin's repository. 
+
+!!! note
+    The Wails team does not provide support for third-party plugins.

mkdocs-website/mkdocs.yml

@@ -141,6 +141,7 @@ nav:
     - Next Steps: getting-started/next-steps.md
     - Learn More:
         - Runtime: learn/runtime.md
+        - Plugins: learn/plugins.md
     - Feedback: getting-started/feedback.md
   - Feedback: getting-started/feedback.md
   - What's New in v3?: whats-new.md

v2/cmd/wails/doctor.go

@@ -67,7 +67,7 @@ func diagnoseEnvironment(f *flags.Doctor) error {
 		wailsTableData = append(wailsTableData, []string{"Package Manager", info.PM.Name()})
 	}
 
-	err = pterm.DefaultTable.WithData(wailsTableData).Render()
+	err = pterm.DefaultTable.WithBoxed().WithData(wailsTableData).Render()
 	if err != nil {
 		return err
 	}

v2/internal/staticanalysis/test/standard/go.mod

@@ -1,8 +1,8 @@
 module changeme
 
-go 1.18
+go 1.22
 
-require github.com/wailsapp/wails/v2 v2.3.1
+require github.com/wailsapp/wails/v2 v2.8.0
 
 require (
 	github.com/bep/debounce v1.2.1 // indirect

v3/Taskfile.yaml

@@ -132,12 +132,28 @@ tasks:
       - task: format
 #      - task: docs:update:api
 
-  test:example:
+  test:example:darwin:
     dir: 'examples/{{.DIR}}'
+    platforms:
+      - darwin
     cmds:
       - echo "Building example {{.DIR}}"
       - go mod tidy
       - go build -o "testbuild-{{.DIR}}{{exeExt}}"
+    env:
+      CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
+      CGO_CFLAGS: -mmacosx-version-min=10.13
+
+  test:example:notdarwin:
+    dir: 'examples/{{.DIR}}'
+    platforms:
+      - linux
+      - windows
+    cmds:
+      - echo "Building example {{.DIR}}"
+      - go mod tidy
+      - go build -o "testbuild-{{.DIR}}{{exeExt}}"
+
 
   test:examples:
     summary: Builds the examples
@@ -155,10 +171,8 @@ tasks:
         hide-window
         keybindings
         menu
-        oauth
         plain
         screen
-        server
         show-macos-toolbar
         systray
         video
@@ -167,6 +181,10 @@ tasks:
         wml
     cmds:
       - for: { var: EXAMPLEDIRS }
-        task: test:example
+        task: test:example:darwin
+        vars:
+          DIR: "{{.ITEM}}"
+      - for: { var: EXAMPLEDIRS }
+        task: test:example:notdarwin
         vars:
           DIR: "{{.ITEM}}"

v3/examples/binding/GreetService.go

@@ -1,17 +1,26 @@
 package main
 
-import "github.com/wailsapp/wails/v3/examples/binding/data"
+import (
+	"context"
+	"github.com/wailsapp/wails/v3/pkg/application"
+)
 
 // GreetService is a service that greets people
 type GreetService struct {
 }
 
 // Greet greets a person
-func (*GreetService) Greet(name string) string {
-	return "Hello " + name
+func (*GreetService) Greet(win application.Window, name string) string {
+	return "Hello " + name + " on " + win.Name()
 }
 
-// GreetPerson greets a person
-func (*GreetService) GreetPerson(person data.Person) string {
-	return "Hello " + person.Name
+// GreetWithCtx greets a person
+func (*GreetService) GreetWithCtx(ctx context.Context, name string) string {
+	win := ctx.Value("window").(application.Window)
+	return "[ctx] Hello " + name + " on " + win.Name()
+}
+
+// GreetWithCtx greets a person
+func (*GreetService) GreetWithBoth(_ context.Context, win application.Window, name string) string {
+	return "[ctx+win] Hello " + name + " on " + win.Name()
 }

v3/examples/binding/assets/bindings/data/models.js

@@ -1,28 +0,0 @@
-// @ts-check
-// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
-// This file is automatically generated. DO NOT EDIT
-
-// Person holds someone's most important attributes
-export const Person = class {
-    /**
-     * Creates a new Person instance.
-     * @constructor
-     * @param {Object} source - The source object to create the Person.
-     * @param {string} source.Name
-     */
-    constructor(source = {}) {
-        const { name = "" } = source;        
-        this.name = name;
-    }
-
-    /**
-     * Creates a new Person instance from a string or object.
-     * @param {string|object} source - The source data to create a Person instance from.
-     * @returns {Person} A new Person instance.
-     */
-    static createFrom(source) {
-        let parsedSource = typeof source === 'string' ? JSON.parse(source) : source;
-        return new Person(parsedSource);
-    }
-};
-

v3/examples/binding/assets/bindings/main/GreetService.js

@@ -19,10 +19,20 @@ export async function Greet(name) {
 
 /**
  * GreetPerson greets a person
- * @function GreetPerson
- * @param person {dataPerson}
+ * @function GreetWithCtx
+ * @param name {string}
  * @returns {Promise<string>}
  **/
-export async function GreetPerson(person) {
-	return Call.ByName("main.GreetService.GreetPerson", ...Array.prototype.slice.call(arguments, 0));
+export async function GreetWithCtx(name) {
+	return Call.ByName("main.GreetService.GreetWithCtx", ...Array.prototype.slice.call(arguments, 0));
+}
+
+/**
+ * GreetPerson greets a person
+ * @function GreetWithBoth
+ * @param name {string}
+ * @returns {Promise<string>}
+ **/
+export async function GreetWithBoth(name) {
+	return Call.ByName("main.GreetService.GreetWithBoth", ...Array.prototype.slice.call(arguments, 0));
 }

v3/examples/binding/assets/index.html

@@ -83,9 +83,19 @@
 <script type="module">
     import * as GreetService from "./bindings/main/GreetService.js";
 
+    let state = 0;
     async function greet() {
-        document.getElementById("result").innerHTML =
-            await GreetService.Greet(document.getElementById("name").value);
+        if(state % 3 === 0) {
+            document.getElementById("result").innerHTML =
+                await GreetService.Greet(document.getElementById("name").value);
+        } else if(state % 3 === 1) {
+            document.getElementById("result").innerHTML =
+                await GreetService.GreetWithCtx(document.getElementById("name").value);
+        } else {
+            document.getElementById("result").innerHTML =
+                await GreetService.GreetWithBoth(document.getElementById("name").value);
+        }
+        state++;
     }
 
     document.getElementById("greet-btn").onclick = greet;

v3/examples/binding/main.go

@@ -26,6 +26,8 @@ func main() {
 
 	app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
 		URL:             "/",
+		Name:            "Window 1",
+		Title:           "Window 1",
 		DevToolsEnabled: true,
 	})
 

v3/examples/environment/assets/index.html

@@ -7,7 +7,8 @@
         body {
             padding-top: 75px;
             margin: 0 auto;
-            color: white;
+            background-color: white;
+            color: black;
             text-align: -webkit-center;
             font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif
         }
@@ -54,9 +55,7 @@
         html += "<tr><td>Debug</td><td>"+ result.Debug +"</td></tr>";
         if(result.PlatformInfo) {
             for (let key in result.PlatformInfo) {
-                if (obj.hasOwnProperty(key)) {
                     html += "<tr><td>"+key+"</td><td>"+ result.PlatformInfo[key] +"</td></tr>";
-                }
             }
         }
         html += "</table>";

v3/examples/frameless/assets/index.html

@@ -24,10 +24,10 @@
 </head>
 <body>
 <div class="container">
-    <div class="quarter" style="background-color: lightblue; --webkit-app-region: drag">Draggable</div>
+    <div class="quarter" style="background-color: lightblue; --wails-draggable: drag">Draggable</div>
     <div class="quarter" style="background-color: lightgreen;">Not Draggable</div>
     <div class="quarter" style="background-color: lightpink;">Not Draggable</div>
-    <div class="quarter" style="background-color: lightyellow; --webkit-app-region: drag">Draggable</div>
+    <div class="quarter" style="background-color: lightyellow; --wails-draggable: drag">Draggable</div>
 </div>
 </body>
 </html>

v3/examples/oauth/README.md

@@ -1,3 +0,0 @@
-# OAuth Example
-
-This example is not ready for testing yet.

v3/examples/oauth/assets/index.html

@@ -1,41 +0,0 @@
-<!-- templates/index.html -->
-<!doctype html>
-<html>
-<head>
-    <title>Google SignIn</title>
-    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"> <!-- load bulma css -->
-    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"> <!-- load fontawesome -->
-</head>
-<body>
-<div id="main" class="container">
-    <div class="jumbotron text-center text-success" style="padding-top:70px;">
-        <h1><span class="fa fa-lock"></span> Social Authentication</h1>
-        <p>Login or Register with:</p>
-        <a wml-event="github-login" class="btn btn-primary"><span class="fa fa-github" style="color: #FFF"></span> SignIn with Github</a>
-    </div>
-</div>
-<div id="details" class="text-center" style="display: none">
-    <image id="logo" style="width:250px"></image>
-    <h3 id="name" style="padding-top: 10px"></h3>
-    <a wml-event="github-logout" class="btn btn-primary"><span class="fa fa-github" style="color: #FFF"></span> Logout </a>
-</div>
-<script type="module">
-    import * as wails from "/wails/runtime.js";
-
-    wails.Events.On("wails:oauth:success", (event) => {
-        document.getElementById("main").style.display = "none";
-        document.getElementById("details").style.display = "block";
-        document.getElementById("name").innerText = event.data.Name;
-        document.getElementById("logo").src = event.data.AvatarURL;
-        document.body.style.backgroundColor = "#000";
-        document.body.style.color = "#FFF";
-    });
-    wails.Events.On("wails:oauth:loggedout", (event) => {
-        document.getElementById("details").style.display = "none";
-        document.getElementById("main").style.display = "block";
-        document.body.style.backgroundColor = "#FFF";
-        document.body.style.color = "#000";
-    });
-</script>
-</body>
-</html>

v3/examples/oauth/main.go

@@ -1,68 +0,0 @@
-package main
-
-import (
-	"embed"
-	_ "embed"
-	"log"
-	"os"
-
-	"github.com/markbates/goth"
-	"github.com/markbates/goth/providers/github"
-	"github.com/wailsapp/wails/v3/pkg/application"
-	"github.com/wailsapp/wails/v3/plugins/oauth"
-)
-
-//go:embed assets
-var assets embed.FS
-
-func main() {
-
-	oAuthPlugin := oauth.NewPlugin(oauth.Config{
-		Providers: []goth.Provider{
-			github.New(
-				os.Getenv("clientkey"),
-				os.Getenv("secret"),
-				"http://localhost:9876/auth/github/callback",
-				"email",
-				"profile"),
-		},
-	})
-
-	app := application.New(application.Options{
-		Name:        "OAuth Demo",
-		Description: "A demo of the oauth Plugin",
-		Mac: application.MacOptions{
-			ApplicationShouldTerminateAfterLastWindowClosed: true,
-		},
-		Assets: application.AssetOptions{
-			Handler: application.AssetFileServerFS(assets),
-		},
-		Plugins: map[string]application.Plugin{
-			"github.com/wailsapp/wails/v3/plugins/oauth": oAuthPlugin,
-		},
-	})
-
-	app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
-		Title:                  "OAuth Demo",
-		DevToolsEnabled:        true,
-		OpenInspectorOnStartup: true,
-		Mac: application.MacWindow{
-			Backdrop:                application.MacBackdropTranslucent,
-			TitleBar:                application.MacTitleBarHiddenInsetUnified,
-			InvisibleTitleBarHeight: 50,
-		},
-	})
-
-	app.Events.On("github-login", func(e *application.WailsEvent) {
-		oAuthPlugin.Github()
-	})
-	app.Events.On("github-logout", func(e *application.WailsEvent) {
-		oAuthPlugin.LogoutGithub()
-	})
-
-	err := app.Run()
-
-	if err != nil {
-		log.Fatal(err.Error())
-	}
-}