The application API assists in creating an application using the Wails +framework.
+API: New(appOptions Options) *App
New(appOptions Options) creates a new application using the given application
+options . It applies default values for unspecified options, merges them with
+the provided ones, initializes and returns an instance of the application.
In case of an error during initialization, the application is stopped with the +error message provided.
+It should be noted that if a global application instance already exists, that +instance will be returned instead of creating a new one.
+package main
+
+import "github.com/wailsapp/wails/v3/pkg/application"
+
+func main() {
+ app := application.New(application.Options{
+ Name: "WebviewWindow Demo",
+ // Other options
+ })
+
+ // Rest of application
+}
+Get() returns the global application instance. It's useful when you need to
+access the application from different parts of your code.
API: Capabilities() capabilities.Capabilities
Capabilities() retrieves a map of capabilities that the application currently
+has. Capabilities can be about different features the operating system provides,
+like webview features.
// Get the application capabilities
+ capabilities := app.Capabilities()
+ if capabilities.HasNativeDrag {
+ // Do something
+ }
+API: GetPID() int
GetPID() returns the Process ID of the application.
API: Run() error
Run() starts the execution of the application and its components.
app := application.New(application.Options{
+ //options
+ })
+ // Run the application
+ err := application.Run()
+ if err != nil {
+ // Handle error
+ }
+API: Quit()
Quit() quits the application by destroying windows and potentially other
+components.
API: IsDarkMode() bool
IsDarkMode() checks if the application is running in dark mode. It returns a
+boolean indicating whether dark mode is enabled.
API: Hide()
Hide() hides the application window.
API: Show()
Show() shows the application window.
API: NewWebviewWindow() *WebviewWindow
NewWebviewWindow() creates a new Webview window with default options, and
+returns it.
API:
+NewWebviewWindowWithOptions(windowOptions WebviewWindowOptions) *WebviewWindow
NewWebviewWindowWithOptions() creates a new webview window with custom
+options. The newly created window is added to a map of windows managed by the
+application.
// Create a new webview window with custom options
+ window := app.NewWebviewWindowWithOptions(WebviewWindowOptions{
+ Name: "Main",
+ Title: "My Window",
+ Width: 800,
+ Height: 600,
+ })
+API: OnWindowCreation(callback func(window *WebviewWindow))
OnWindowCreation() registers a callback function to be called when a window is
+created.
// Register a callback to be called when a window is created
+ app.OnWindowCreation(func(window *WebviewWindow) {
+ // Do something
+ })
+API: GetWindowByName(name string) *WebviewWindow
GetWindowByName() fetches and returns a window with a specific name.
API: CurrentWindow() *WebviewWindow
CurrentWindow() fetches and returns a pointer to the currently active window
+in the application. If there is no window, it returns nil.
API: RegisterContextMenu(name string, menu *Menu)
RegisterContextMenu() registers a context menu with a given name. This menu
+can be used later in the application.
// Create a new menu
+ ctxmenu := app.NewMenu()
+
+ // Register the menu as a context menu
+ app.RegisterContextMenu("MyContextMenu", ctxmenu)
+API: SetMenu(menu *Menu)
SetMenu() sets the menu for the application. On Mac, this will be the global
+menu. For Windows and Linux, this will be the default menu for any new window
+created.
// Create a new menu
+ menu := app.NewMenu()
+
+ // Set the menu for the application
+ app.SetMenu(menu)
+API: ShowAboutDialog()
ShowAboutDialog() shows an "About" dialog box. It can show the application's
+name, description and icon.
API: InfoDialog()
InfoDialog() creates and returns a new instance of MessageDialog with an
+InfoDialogType. This dialog is typically used to display informational
+messages to the user.
API: QuestionDialog()
QuestionDialog() creates and returns a new instance of MessageDialog with a
+QuestionDialogType. This dialog is often used to ask a question to the user
+and expect a response.
API: WarningDialog()
WarningDialog() creates and returns a new instance of MessageDialog with a
+WarningDialogType. As the name suggests, this dialog is primarily used to
+display warning messages to the user.
API: ErrorDialog()
ErrorDialog() creates and returns a new instance of MessageDialog with an
+ErrorDialogType. This dialog is designed to be used when you need to display
+an error message to the user.
API: OpenFileDialog()
OpenFileDialog() creates and returns a new OpenFileDialogStruct. This dialog
+prompts the user to select one or more files from their file system.
API: SaveFileDialog()
SaveFileDialog() creates and returns a new SaveFileDialogStruct. This dialog
+prompts the user to choose a location on their file system where a file should
+be saved.
API: OpenDirectoryDialog()
OpenDirectoryDialog() creates and returns a new instance of MessageDialog
+with an OpenDirectoryDialogType. This dialog enables the user to choose a
+directory from their file system.
API:
+On(eventType events.ApplicationEventType, callback func(event *Event)) func()
On() registers an event listener for specific application events. The callback
+function provided will be triggered when the corresponding event occurs. The
+function returns a function that can be called to remove the listener.
API:
+RegisterHook(eventType events.ApplicationEventType, callback func(event *Event)) func()
RegisterHook() registers a callback to be run as a hook during specific
+events. These hooks are run before listeners attached with On(). The function
+returns a function that can be called to remove the hook.
API: GetPrimaryScreen() (*Screen, error)
GetPrimaryScreen() returns the primary screen of the system.
API: GetScreens() ([]*Screen, error)
GetScreens() returns information about all screens attached to the system.
This is a brief summary of the exported methods in the provided App struct. Do
+note that for more detailed functionality or considerations, refer to the actual
+Go code or further internal documentation.
package application
+
+import (
+ "io/fs"
+ "log/slog"
+ "net/http"
+)
+
+type Options struct {
+ // Name is the name of the application
+ Name string
+
+ // Description is the description of the application (used in the default about box)
+ Description string
+
+ // Icon is the icon of the application (used in the default about box)
+ Icon []byte
+
+ // Mac is the Mac specific configuration for Mac builds
+ Mac MacOptions
+
+ // Windows is the Windows specific configuration for Windows builds
+ Windows WindowsOptions
+
+ // Bind allows you to bind Go methods to the frontend.
+ Bind []any
+
+ // BindAliases allows you to specify alias IDs for your bound methods.
+ // Example: `BindAliases: map[uint32]uint32{1: 1411160069}` states that alias ID 1 maps to the Go method with ID 1411160069.
+ BindAliases map[uint32]uint32
+
+ // Logger i a slog.Logger instance used for logging Wails system messages (not application messages).
+ // If not defined, a default logger is used.
+ Logger *slog.Logger
+
+ // LogLevel defines the log level of the Wails system logger.
+ LogLevel slog.Level
+
+ // Assets are the application assets to be used.
+ Assets AssetOptions
+
+ // Plugins is a map of plugins used by the application
+ Plugins map[string]Plugin
+
+ // Flags are key value pairs that are available to the frontend.
+ // This is also used by Wails to provide information to the frontend.
+ Flags map[string]any
+
+ // PanicHandler is a way to register a custom panic handler
+ PanicHandler func(any)
+
+ // KeyBindings is a map of key bindings to functions
+ KeyBindings map[string]func(window *WebviewWindow)
+}
+
+// AssetOptions defines the configuration of the AssetServer.
+type AssetOptions struct {
+ // FS defines the static assets to be used. A GET request is first tried to be served from this FS. If the FS returns
+ // `os.ErrNotExist` for that file, the request handling will fallback to the Handler and tries to serve the GET
+ // request from it.
+ //
+ // If set to nil, all GET requests will be forwarded to Handler.
+ FS fs.FS
+
+ // Handler will be called for every GET request that can't be served from FS, due to `os.ErrNotExist`. Furthermore all
+ // non GET requests will always be served from this Handler.
+ //
+ // If not defined, the result is the following in cases where the Handler would have been called:
+ // GET request: `http.StatusNotFound`
+ // Other request: `http.StatusMethodNotAllowed`
+ Handler http.Handler
+
+ // Middleware is HTTP Middleware which allows to hook into the AssetServer request chain. It allows to skip the default
+ // request handler dynamically, e.g. implement specialized Routing etc.
+ // The Middleware is called to build a new `http.Handler` used by the AssetSever and it also receives the default
+ // handler used by the AssetServer as an argument.
+ //
+ // If not defined, the default AssetServer request chain is executed.
+ //
+ // Multiple Middlewares can be chained together with:
+ // ChainMiddleware(middleware ...Middleware) Middleware
+ Middleware Middleware
+
+ // External URL can be set to a development server URL so that all requests are forwarded to it. This is useful
+ // when using a development server like `vite` or `snowpack` which serves the assets on a different port.
+ ExternalURL string
+}
+
+// Middleware defines HTTP middleware that can be applied to the AssetServer.
+// The handler passed as next is the next handler in the chain. One can decide to call the next handler
+// or implement a specialized handling.
+type Middleware func(next http.Handler) http.Handler
+
+// ChainMiddleware allows chaining multiple middlewares to one middleware.
+func ChainMiddleware(middleware ...Middleware) Middleware {
+ return func(h http.Handler) http.Handler {
+ for i := len(middleware) - 1; i >= 0; i-- {
+ h = middleware[i](h)
+ }
+ return h
+ }
+}
+package application
+
+// WindowsOptions contains options for Windows applications.
+type WindowsOptions struct {
+
+ // WndProcInterceptor is a function that will be called for every message sent in the application.
+ // Use this to hook into the main message loop. This is useful for handling custom window messages.
+ // If `shouldReturn` is `true` then `returnCode` will be returned by the main message loop.
+ // If `shouldReturn` is `false` then returnCode will be ignored and the message will be processed by the main message loop.
+ WndProcInterceptor func(hwnd uintptr, msg uint32, wParam, lParam uintptr) (returnCode uintptr, shouldReturn bool)
+
+ // DisableQuitOnLastWindowClosed disables the auto quit of the application if the last window has been closed.
+ DisableQuitOnLastWindowClosed bool
+
+ // Path where the WebView2 stores the user data. If empty %APPDATA%\[BinaryName.exe] will be used.
+ // If the path is not valid, a messagebox will be displayed with the error and the app will exit with error code.
+ WebviewUserDataPath string
+
+ // Path to the directory with WebView2 executables. If empty WebView2 installed in the system will be used.
+ WebviewBrowserPath string
+}
+package application
+
+// ActivationPolicy is the activation policy for the application.
+type ActivationPolicy int
+
+const (
+ // ActivationPolicyRegular is used for applications that have a user interface,
+ ActivationPolicyRegular ActivationPolicy = iota
+ // ActivationPolicyAccessory is used for applications that do not have a main window,
+ // such as system tray applications or background applications.
+ ActivationPolicyAccessory
+ ActivationPolicyProhibited
+)
+
+// MacOptions contains options for macOS applications.
+type MacOptions struct {
+ // ActivationPolicy is the activation policy for the application. Defaults to
+ // applicationActivationPolicyRegular.
+ ActivationPolicy ActivationPolicy
+ // If set to true, the application will terminate when the last window is closed.
+ ApplicationShouldTerminateAfterLastWindowClosed bool
+}
+const (
+ DialogInfo = 0
+ DialogWarning = 1
+ DialogError = 2
+ DialogQuestion = 3
+ DialogOpenFile = 4
+ DialogSaveFile = 5
+)
+const (
+ WindowCenter = 0
+ WindowSetTitle = 1
+ WindowFullscreen = 2
+ WindowUnFullscreen = 3
+ WindowSetSize = 4
+ WindowSize = 5
+ WindowSetMaxSize = 6
+ WindowSetMinSize = 7
+ WindowSetAlwaysOnTop = 8
+ WindowSetRelativePosition = 9
+ WindowRelativePosition = 10
+ WindowScreen = 11
+ WindowHide = 12
+ WindowMaximise = 13
+ WindowUnMaximise = 14
+ WindowToggleMaximise = 15
+ WindowMinimise = 16
+ WindowUnMinimise = 17
+ WindowRestore = 18
+ WindowShow = 19
+ WindowClose = 20
+ WindowSetBackgroundColour = 21
+ WindowSetResizable = 22
+ WindowWidth = 23
+ WindowHeight = 24
+ WindowZoomIn = 25
+ WindowZoomOut = 26
+ WindowZoomReset = 27
+ WindowGetZoomLevel = 28
+ WindowSetZoomLevel = 29
+)
+const (
+ NSImageNone = iota
+ NSImageOnly
+ NSImageLeft
+ NSImageRight
+ NSImageBelow
+ NSImageAbove
+ NSImageOverlaps
+ NSImageLeading
+ NSImageTrailing
+)
+BuildInfo contains the build info for the application
+ +BuildSettings contains the build settings for the +application
+ +MacTitleBarDefault results in the default Mac +MacTitleBar
+var MacTitleBarDefault = MacTitleBar{
+ AppearsTransparent: false,
+ Hide: false,
+ HideTitle: false,
+ FullSizeContent: false,
+ UseToolbar: false,
+ HideToolbarSeparator: false,
+}
+MacTitleBarHidden results in a hidden title bar +and a full size content window, yet the title bar still has the standard window +controls (“traffic lights”) in the top left.
+var MacTitleBarHidden = MacTitleBar{
+ AppearsTransparent: true,
+ Hide: false,
+ HideTitle: true,
+ FullSizeContent: true,
+ UseToolbar: false,
+ HideToolbarSeparator: false,
+}
+MacTitleBarHiddenInset results in a hidden +title bar with an alternative look where the traffic light buttons are slightly +more inset from the window edge.
+var MacTitleBarHiddenInset = MacTitleBar{
+ AppearsTransparent: true,
+ Hide: false,
+ HideTitle: true,
+ FullSizeContent: true,
+ UseToolbar: true,
+ HideToolbarSeparator: true,
+}
+MacTitleBarHiddenInsetUnified +results in a hidden title bar with an alternative look where the traffic light +buttons are even more inset from the window edge.
+var MacTitleBarHiddenInsetUnified = MacTitleBar{
+ AppearsTransparent: true,
+ Hide: false,
+ HideTitle: true,
+ FullSizeContent: true,
+ UseToolbar: true,
+ HideToolbarSeparator: true,
+ ToolbarStyle: MacToolbarStyleUnified,
+}
+var VirtualKeyCodes = map[uint]string{
+ 0x01: "lbutton",
+ 0x02: "rbutton",
+ 0x03: "cancel",
+ 0x04: "mbutton",
+ 0x05: "xbutton1",
+ 0x06: "xbutton2",
+ 0x08: "back",
+ 0x09: "tab",
+ 0x0C: "clear",
+ 0x0D: "return",
+ 0x10: "shift",
+ 0x11: "control",
+ 0x12: "menu",
+ 0x13: "pause",
+ 0x14: "capital",
+ 0x15: "kana",
+ 0x17: "junja",
+ 0x18: "final",
+ 0x19: "hanja",
+ 0x1B: "escape",
+ 0x1C: "convert",
+ 0x1D: "nonconvert",
+ 0x1E: "accept",
+ 0x1F: "modechange",
+ 0x20: "space",
+ 0x21: "prior",
+ 0x22: "next",
+ 0x23: "end",
+ 0x24: "home",
+ 0x25: "left",
+ 0x26: "up",
+ 0x27: "right",
+ 0x28: "down",
+ 0x29: "select",
+ 0x2A: "print",
+ 0x2B: "execute",
+ 0x2C: "snapshot",
+ 0x2D: "insert",
+ 0x2E: "delete",
+ 0x2F: "help",
+ 0x30: "0",
+ 0x31: "1",
+ 0x32: "2",
+ 0x33: "3",
+ 0x34: "4",
+ 0x35: "5",
+ 0x36: "6",
+ 0x37: "7",
+ 0x38: "8",
+ 0x39: "9",
+ 0x41: "a",
+ 0x42: "b",
+ 0x43: "c",
+ 0x44: "d",
+ 0x45: "e",
+ 0x46: "f",
+ 0x47: "g",
+ 0x48: "h",
+ 0x49: "i",
+ 0x4A: "j",
+ 0x4B: "k",
+ 0x4C: "l",
+ 0x4D: "m",
+ 0x4E: "n",
+ 0x4F: "o",
+ 0x50: "p",
+ 0x51: "q",
+ 0x52: "r",
+ 0x53: "s",
+ 0x54: "t",
+ 0x55: "u",
+ 0x56: "v",
+ 0x57: "w",
+ 0x58: "x",
+ 0x59: "y",
+ 0x5A: "z",
+ 0x5B: "lwin",
+ 0x5C: "rwin",
+ 0x5D: "apps",
+ 0x5F: "sleep",
+ 0x60: "numpad0",
+ 0x61: "numpad1",
+ 0x62: "numpad2",
+ 0x63: "numpad3",
+ 0x64: "numpad4",
+ 0x65: "numpad5",
+ 0x66: "numpad6",
+ 0x67: "numpad7",
+ 0x68: "numpad8",
+ 0x69: "numpad9",
+ 0x6A: "multiply",
+ 0x6B: "add",
+ 0x6C: "separator",
+ 0x6D: "subtract",
+ 0x6E: "decimal",
+ 0x6F: "divide",
+ 0x70: "f1",
+ 0x71: "f2",
+ 0x72: "f3",
+ 0x73: "f4",
+ 0x74: "f5",
+ 0x75: "f6",
+ 0x76: "f7",
+ 0x77: "f8",
+ 0x78: "f9",
+ 0x79: "f10",
+ 0x7A: "f11",
+ 0x7B: "f12",
+ 0x7C: "f13",
+ 0x7D: "f14",
+ 0x7E: "f15",
+ 0x7F: "f16",
+ 0x80: "f17",
+ 0x81: "f18",
+ 0x82: "f19",
+ 0x83: "f20",
+ 0x84: "f21",
+ 0x85: "f22",
+ 0x86: "f23",
+ 0x87: "f24",
+ 0x88: "navigation_view",
+ 0x89: "navigation_menu",
+ 0x8A: "navigation_up",
+ 0x8B: "navigation_down",
+ 0x8C: "navigation_left",
+ 0x8D: "navigation_right",
+ 0x8E: "navigation_accept",
+ 0x8F: "navigation_cancel",
+ 0x90: "numlock",
+ 0x91: "scroll",
+ 0x92: "oem_nec_equal",
+ 0x93: "oem_fj_masshou",
+ 0x94: "oem_fj_touroku",
+ 0x95: "oem_fj_loya",
+ 0x96: "oem_fj_roya",
+ 0xA0: "lshift",
+ 0xA1: "rshift",
+ 0xA2: "lcontrol",
+ 0xA3: "rcontrol",
+ 0xA4: "lmenu",
+ 0xA5: "rmenu",
+ 0xA6: "browser_back",
+ 0xA7: "browser_forward",
+ 0xA8: "browser_refresh",
+ 0xA9: "browser_stop",
+ 0xAA: "browser_search",
+ 0xAB: "browser_favorites",
+ 0xAC: "browser_home",
+ 0xAD: "volume_mute",
+ 0xAE: "volume_down",
+ 0xAF: "volume_up",
+ 0xB0: "media_next_track",
+ 0xB1: "media_prev_track",
+ 0xB2: "media_stop",
+ 0xB3: "media_play_pause",
+ 0xB4: "launch_mail",
+ 0xB5: "launch_media_select",
+ 0xB6: "launch_app1",
+ 0xB7: "launch_app2",
+ 0xBA: "oem_1",
+ 0xBB: "oem_plus",
+ 0xBC: "oem_comma",
+ 0xBD: "oem_minus",
+ 0xBE: "oem_period",
+ 0xBF: "oem_2",
+ 0xC0: "oem_3",
+ 0xC3: "gamepad_a",
+ 0xC4: "gamepad_b",
+ 0xC5: "gamepad_x",
+ 0xC6: "gamepad_y",
+ 0xC7: "gamepad_right_shoulder",
+ 0xC8: "gamepad_left_shoulder",
+ 0xC9: "gamepad_left_trigger",
+ 0xCA: "gamepad_right_trigger",
+ 0xCB: "gamepad_dpad_up",
+ 0xCC: "gamepad_dpad_down",
+ 0xCD: "gamepad_dpad_left",
+ 0xCE: "gamepad_dpad_right",
+ 0xCF: "gamepad_menu",
+ 0xD0: "gamepad_view",
+ 0xD1: "gamepad_left_thumbstick_button",
+ 0xD2: "gamepad_right_thumbstick_button",
+ 0xD3: "gamepad_left_thumbstick_up",
+ 0xD4: "gamepad_left_thumbstick_down",
+ 0xD5: "gamepad_left_thumbstick_right",
+ 0xD6: "gamepad_left_thumbstick_left",
+ 0xD7: "gamepad_right_thumbstick_up",
+ 0xD8: "gamepad_right_thumbstick_down",
+ 0xD9: "gamepad_right_thumbstick_right",
+ 0xDA: "gamepad_right_thumbstick_left",
+ 0xDB: "oem_4",
+ 0xDC: "oem_5",
+ 0xDD: "oem_6",
+ 0xDE: "oem_7",
+ 0xDF: "oem_8",
+ 0xE1: "oem_ax",
+ 0xE2: "oem_102",
+ 0xE3: "ico_help",
+ 0xE4: "ico_00",
+ 0xE5: "processkey",
+ 0xE6: "ico_clear",
+ 0xE7: "packet",
+ 0xE9: "oem_reset",
+ 0xEA: "oem_jump",
+ 0xEB: "oem_pa1",
+ 0xEC: "oem_pa2",
+ 0xED: "oem_pa3",
+ 0xEE: "oem_wsctrl",
+ 0xEF: "oem_cusel",
+ 0xF0: "oem_attn",
+ 0xF1: "oem_finish",
+ 0xF2: "oem_copy",
+ 0xF3: "oem_auto",
+ 0xF4: "oem_enlw",
+ 0xF5: "oem_backtab",
+ 0xF6: "attn",
+ 0xF7: "crsel",
+ 0xF8: "exsel",
+ 0xF9: "ereof",
+ 0xFA: "play",
+ 0xFB: "zoom",
+ 0xFC: "noname",
+ 0xFD: "pa1",
+ 0xFE: "oem_clear",
+}
+var WebviewWindowDefaults = &WebviewWindowOptions{
+ Title: "",
+ Width: 800,
+ Height: 600,
+ URL: "",
+ BackgroundColour: RGBA{
+ Red: 255,
+ Green: 255,
+ Blue: 255,
+ Alpha: 255,
+ },
+}
+ActivationPolicy is the activation policy for the application.
+ + +const (
+ // ActivationPolicyRegular is used for applications that have a user interface,
+ ActivationPolicyRegular ActivationPolicy = iota
+ // ActivationPolicyAccessory is used for applications that do not have a main window,
+ // such as system tray applications or background applications.
+ ActivationPolicyAccessory
+ ActivationPolicyProhibited
+)
+type App struct {
+
+ // The main application menu
+ ApplicationMenu *Menu
+
+ Events *EventProcessor
+ Logger *slog.Logger
+ // contains filtered or unexported fields
+}
+func (a *App) RegisterHook(eventType events.ApplicationEventType, callback func(event *Event)) func()
+RegisterHook registers a hook for the given event type. Hooks are called before +the event listeners and can cancel the event. The returned function can be +called to remove the hook.
+ +AssetOptions defines the configuration of the AssetServer.
+type AssetOptions struct {
+ // FS defines the static assets to be used. A GET request is first tried to be served from this FS. If the FS returns
+ // `os.ErrNotExist` for that file, the request handling will fallback to the Handler and tries to serve the GET
+ // request from it.
+ //
+ // If set to nil, all GET requests will be forwarded to Handler.
+ FS fs.FS
+
+ // Handler will be called for every GET request that can't be served from FS, due to `os.ErrNotExist`. Furthermore all
+ // non GET requests will always be served from this Handler.
+ //
+ // If not defined, the result is the following in cases where the Handler would have been called:
+ // GET request: `http.StatusNotFound`
+ // Other request: `http.StatusMethodNotAllowed`
+ Handler http.Handler
+
+ // Middleware is HTTP Middleware which allows to hook into the AssetServer request chain. It allows to skip the default
+ // request handler dynamically, e.g. implement specialized Routing etc.
+ // The Middleware is called to build a new `http.Handler` used by the AssetSever and it also receives the default
+ // handler used by the AssetServer as an argument.
+ //
+ // If not defined, the default AssetServer request chain is executed.
+ //
+ // Multiple Middlewares can be chained together with:
+ // ChainMiddleware(middleware ...Middleware) Middleware
+ Middleware Middleware
+
+ // External URL can be set to a development server URL so that all requests are forwarded to it. This is useful
+ // when using a development server like `vite` or `snowpack` which serves the assets on a different port.
+ ExternalURL string
+}
+const (
+ Auto BackdropType = 0
+ None BackdropType = 1
+ Mica BackdropType = 2
+ Acrylic BackdropType = 3
+ Tabbed BackdropType = 4
+)
+const (
+ BackgroundTypeSolid BackgroundType = iota
+ BackgroundTypeTransparent
+ BackgroundTypeTranslucent
+)
+Add the given struct methods to the Bindings
+ +GenerateID generates a unique ID for a binding
+ +Get returns the bound method with the given name
+ +GetByID returns the bound method with the given ID
+ +BoundMethod defines all the data related to a Go method that is bound to the +Wails application
+type BoundMethod struct {
+ ID uint32 `json:"id"`
+ Name string `json:"name"`
+ Inputs []*Parameter `json:"inputs,omitempty"`
+ Outputs []*Parameter `json:"outputs,omitempty"`
+ Comments string `json:"comments,omitempty"`
+ Method reflect.Value `json:"-"`
+ PackageName string
+ StructName string
+ PackagePath string
+}
+Call will attempt to call this bound method with the given args
+ +type CallOptions struct {
+ MethodID uint32 `json:"methodID"`
+ PackageName string `json:"packageName"`
+ StructName string `json:"structName"`
+ MethodName string `json:"methodName"`
+ Args []any `json:"args"`
+}
+type ContextMenuData struct {
+ Id string `json:"id"`
+ X int `json:"x"`
+ Y int `json:"y"`
+ Data any `json:"data"`
+}
+const (
+ InfoDialogType DialogType = iota
+ QuestionDialogType
+ WarningDialogType
+ ErrorDialogType
+ OpenDirectoryDialogType
+)
+EventProcessor handles custom events
+ + +Emit sends an event to all listeners
+ +On is the equivalent of Javascript's `addEventListener`
+ +func (e *EventProcessor) OnMultiple(eventName string, callback func(event *WailsEvent), counter int) func()
+OnMultiple is the same as `On` but will unregister after `count` events
+ +Once is the same as `On` but will unregister after the first event
+ +RegisterHook provides a means of registering methods to be called before +emitting the event
+ +type FileFilter struct {
+ DisplayName string // Filter information EG: "Image Files (*.jpg, *.png)"
+ Pattern string // semicolon separated list of extensions, EG: "*.jpg;*.png"
+}
+MacAppearanceType is a type of Appearance for Cocoa windows
+ + +const (
+ // DefaultAppearance uses the default system value
+ DefaultAppearance MacAppearanceType = ""
+ // NSAppearanceNameAqua - The standard light system appearance.
+ NSAppearanceNameAqua MacAppearanceType = "NSAppearanceNameAqua"
+ // NSAppearanceNameDarkAqua - The standard dark system appearance.
+ NSAppearanceNameDarkAqua MacAppearanceType = "NSAppearanceNameDarkAqua"
+ // NSAppearanceNameVibrantLight - The light vibrant appearance
+ NSAppearanceNameVibrantLight MacAppearanceType = "NSAppearanceNameVibrantLight"
+ // NSAppearanceNameAccessibilityHighContrastAqua - A high-contrast version of the standard light system appearance.
+ NSAppearanceNameAccessibilityHighContrastAqua MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastAqua"
+ // NSAppearanceNameAccessibilityHighContrastDarkAqua - A high-contrast version of the standard dark system appearance.
+ NSAppearanceNameAccessibilityHighContrastDarkAqua MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastDarkAqua"
+ // NSAppearanceNameAccessibilityHighContrastVibrantLight - A high-contrast version of the light vibrant appearance.
+ NSAppearanceNameAccessibilityHighContrastVibrantLight MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastVibrantLight"
+ // NSAppearanceNameAccessibilityHighContrastVibrantDark - A high-contrast version of the dark vibrant appearance.
+ NSAppearanceNameAccessibilityHighContrastVibrantDark MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastVibrantDark"
+)
+MacBackdrop is the backdrop type for macOS
+ + +const (
+ // MacBackdropNormal - The default value. The window will have a normal opaque background.
+ MacBackdropNormal MacBackdrop = iota
+ // MacBackdropTransparent - The window will have a transparent background, with the content underneath it being visible
+ MacBackdropTransparent
+ // MacBackdropTranslucent - The window will have a translucent background, with the content underneath it being "fuzzy" or "frosted"
+ MacBackdropTranslucent
+)
+MacOptions contains options for macOS applications.
+type MacOptions struct {
+ // ActivationPolicy is the activation policy for the application. Defaults to
+ // applicationActivationPolicyRegular.
+ ActivationPolicy ActivationPolicy
+ // If set to true, the application will terminate when the last window is closed.
+ ApplicationShouldTerminateAfterLastWindowClosed bool
+}
+MacTitleBar contains options for the Mac titlebar
+type MacTitleBar struct {
+ // AppearsTransparent will make the titlebar transparent
+ AppearsTransparent bool
+ // Hide will hide the titlebar
+ Hide bool
+ // HideTitle will hide the title
+ HideTitle bool
+ // FullSizeContent will extend the window content to the full size of the window
+ FullSizeContent bool
+ // UseToolbar will use a toolbar instead of a titlebar
+ UseToolbar bool
+ // HideToolbarSeparator will hide the toolbar separator
+ HideToolbarSeparator bool
+ // ToolbarStyle is the style of toolbar to use
+ ToolbarStyle MacToolbarStyle
+}
+MacToolbarStyle is the style of toolbar for macOS
+ + +const (
+ // MacToolbarStyleAutomatic - The default value. The style will be determined by the window's given configuration
+ MacToolbarStyleAutomatic MacToolbarStyle = iota
+ // MacToolbarStyleExpanded - The toolbar will appear below the window title
+ MacToolbarStyleExpanded
+ // MacToolbarStylePreference - The toolbar will appear below the window title and the items in the toolbar will attempt to have equal widths when possible
+ MacToolbarStylePreference
+ // MacToolbarStyleUnified - The window title will appear inline with the toolbar when visible
+ MacToolbarStyleUnified
+ // MacToolbarStyleUnifiedCompact - Same as MacToolbarStyleUnified, but with reduced margins in the toolbar allowing more focus to be on the contents of the window
+ MacToolbarStyleUnifiedCompact
+)
+MacWindow contains macOS specific options for Webview Windows
+type MacWindow struct {
+ // Backdrop is the backdrop type for the window
+ Backdrop MacBackdrop
+ // DisableShadow will disable the window shadow
+ DisableShadow bool
+ // TitleBar contains options for the Mac titlebar
+ TitleBar MacTitleBar
+ // Appearance is the appearance type for the window
+ Appearance MacAppearanceType
+ // InvisibleTitleBarHeight defines the height of an invisible titlebar which responds to dragging
+ InvisibleTitleBarHeight int
+ // Maps events from platform specific to common event types
+ EventMapping map[events.WindowEventType]events.WindowEventType
+
+ // EnableFraudulentWebsiteWarnings will enable warnings for fraudulent websites.
+ // Default: false
+ EnableFraudulentWebsiteWarnings bool
+}
+type MessageDialogOptions struct {
+ DialogType DialogType
+ Title string
+ Message string
+ Buttons []*Button
+ Icon []byte
+ // contains filtered or unexported fields
+}
+Middleware defines HTTP middleware that can be applied to the AssetServer. The +handler passed as next is the next handler in the chain. One can decide to call +the next handler or implement a specialized handling.
+ + +ChainMiddleware allows chaining multiple middlewares to one middleware.
+ +type OpenFileDialogOptions struct {
+ CanChooseDirectories bool
+ CanChooseFiles bool
+ CanCreateDirectories bool
+ ShowHiddenFiles bool
+ ResolvesAliases bool
+ AllowsMultipleSelection bool
+ HideExtension bool
+ CanSelectHiddenExtension bool
+ TreatsFilePackagesAsDirectories bool
+ AllowsOtherFileTypes bool
+ Filters []FileFilter
+ Window *WebviewWindow
+
+ Title string
+ Message string
+ ButtonText string
+ Directory string
+}
+AddFilter adds a filter to the dialog. The filter is a display name and a +semicolon separated list of extensions. EG: AddFilter("Image Files", +"*.jpg;*.png")
+ +func (d *OpenFileDialogStruct) AllowsOtherFileTypes(allowsOtherFileTypes bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) CanChooseDirectories(canChooseDirectories bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) CanCreateDirectories(canCreateDirectories bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) CanSelectHiddenExtension(canSelectHiddenExtension bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) TreatsFilePackagesAsDirectories(treatsFilePackagesAsDirectories bool) *OpenFileDialogStruct
+type Options struct {
+ // Name is the name of the application
+ Name string
+
+ // Description is the description of the application (used in the default about box)
+ Description string
+
+ // Icon is the icon of the application (used in the default about box)
+ Icon []byte
+
+ // Mac is the Mac specific configuration for Mac builds
+ Mac MacOptions
+
+ // Windows is the Windows specific configuration for Windows builds
+ Windows WindowsOptions
+
+ // Bind allows you to bind Go methods to the frontend.
+ Bind []any
+
+ // BindAliases allows you to specify alias IDs for your bound methods.
+ // Example: `BindAliases: map[uint32]uint32{1: 1411160069}` states that alias ID 1 maps to the Go method with ID 1411160069.
+ BindAliases map[uint32]uint32
+
+ // Logger i a slog.Logger instance used for logging Wails system messages (not application messages).
+ // If not defined, a default logger is used.
+ Logger *slog.Logger
+
+ // LogLevel defines the log level of the Wails system logger.
+ LogLevel slog.Level
+
+ // Assets are the application assets to be used.
+ Assets AssetOptions
+
+ // Plugins is a map of plugins used by the application
+ Plugins map[string]Plugin
+
+ // Flags are key value pairs that are available to the frontend.
+ // This is also used by Wails to provide information to the frontend.
+ Flags map[string]any
+
+ // PanicHandler is a way to register a custom panic handler
+ PanicHandler func(any)
+
+ // KeyBindings is a map of key bindings to functions
+ KeyBindings map[string]func(window *WebviewWindow)
+}
+Parameter defines a Go method parameter
+type Parameter struct {
+ Name string `json:"name,omitempty"`
+ TypeName string `json:"type"`
+ ReflectType reflect.Type
+}
+IsError returns true if the parameter type is an error
+ +IsType returns true if the given
+ +type Plugin interface {
+ Name() string
+ Init() error
+ Shutdown()
+ CallableByJS() []string
+ InjectJS() string
+}
+func NewPluginManager(plugins map[string]Plugin, assetServer *assetserver.AssetServer) *PluginManager
+Role is a type to identify menu roles
+ +These constants need to be kept in sync with +`v2/internal/frontend/desktop/darwin/Role.h`
+const (
+ NoRole Role = iota
+ AppMenu Role = iota
+ EditMenu Role = iota
+ ViewMenu Role = iota
+ WindowMenu Role = iota
+ ServicesMenu Role = iota
+ HelpMenu Role = iota
+
+ Hide Role = iota
+ HideOthers Role = iota
+ UnHide Role = iota
+ About Role = iota
+ Undo Role = iota
+ Redo Role = iota
+ Cut Role = iota
+ Copy Role = iota
+ Paste Role = iota
+ PasteAndMatchStyle Role = iota
+ SelectAll Role = iota
+ Delete Role = iota
+ SpeechMenu Role = iota
+ Quit Role = iota
+ FileMenu Role = iota
+ Close Role = iota
+ Reload Role = iota
+ ForceReload Role = iota
+ ToggleDevTools Role = iota
+ ResetZoom Role = iota
+ ZoomIn Role = iota
+ ZoomOut Role = iota
+ ToggleFullscreen Role = iota
+
+ Minimize Role = iota
+ Zoom Role = iota
+ FullScreen Role = iota
+)
+type SaveFileDialogOptions struct {
+ CanCreateDirectories bool
+ ShowHiddenFiles bool
+ CanSelectHiddenExtension bool
+ AllowOtherFileTypes bool
+ HideExtension bool
+ TreatsFilePackagesAsDirectories bool
+ Title string
+ Message string
+ Directory string
+ Filename string
+ ButtonText string
+ Filters []FileFilter
+ Window *WebviewWindow
+}
+AddFilter adds a filter to the dialog. The filter is a display name and a +semicolon separated list of extensions. EG: AddFilter("Image Files", +"*.jpg;*.png")
+ +func (d *SaveFileDialogStruct) AllowsOtherFileTypes(allowOtherFileTypes bool) *SaveFileDialogStruct
+func (d *SaveFileDialogStruct) CanCreateDirectories(canCreateDirectories bool) *SaveFileDialogStruct
+func (d *SaveFileDialogStruct) CanSelectHiddenExtension(canSelectHiddenExtension bool) *SaveFileDialogStruct
+func (d *SaveFileDialogStruct) TreatsFilePackagesAsDirectories(treatsFilePackagesAsDirectories bool) *SaveFileDialogStruct
+type Screen struct {
+ ID string // A unique identifier for the display
+ Name string // The name of the display
+ Scale float32 // The scale factor of the display
+ X int // The x-coordinate of the top-left corner of the rectangle
+ Y int // The y-coordinate of the top-left corner of the rectangle
+ Size Size // The size of the display
+ Bounds Rect // The bounds of the display
+ WorkArea Rect // The work area of the display
+ IsPrimary bool // Whether this is the primary display
+ Rotation float32 // The rotation of the display
+}
+AttachWindow attaches a window to the system tray. The window will be shown when +the system tray icon is clicked. The window will be hidden when the system tray +icon is clicked again, or when the window loses focus.
+ +WindowDebounce is used by Windows to indicate how long to wait before responding +to a mouse up event on the notification icon. This prevents the window from +being hidden and then immediately shown when the user clicks on the system tray +icon. See +https://stackoverflow.com/questions/4585283/alternate-showing-hiding-window-when-notify-icon-is-clicked
+ +WindowOffset sets the gap in pixels between the system tray and the window
+ +const (
+ // SystemDefault will use whatever the system theme is. The application will follow system theme changes.
+ SystemDefault Theme = 0
+ // Dark Mode
+ Dark Theme = 1
+ // Light Mode
+ Light Theme = 2
+)
+ThemeSettings defines custom colours to use in dark or light mode. They may be +set using the hex values: 0x00BBGGRR
+type ThemeSettings struct {
+ DarkModeTitleBar int32
+ DarkModeTitleBarInactive int32
+ DarkModeTitleText int32
+ DarkModeTitleTextInactive int32
+ DarkModeBorder int32
+ DarkModeBorderInactive int32
+ LightModeTitleBar int32
+ LightModeTitleBarInactive int32
+ LightModeTitleText int32
+ LightModeTitleTextInactive int32
+ LightModeBorder int32
+ LightModeBorderInactive int32
+}
+type WailsEvent struct {
+ Name string `json:"name"`
+ Data any `json:"data"`
+ Sender string `json:"sender"`
+ Cancelled bool
+}
+AbsolutePosition returns the absolute position of the window to the screen
+ +Center centers the window on the screen
+ +Close closes the window
+ +ExecJS executes the given javascript in the context of the window.
+ +Flash flashes the window's taskbar button/icon. Windows only.
+ +ForceReload forces the window to reload the page assets
+ +Fullscreen sets the window to fullscreen mode. Min/Max size constraints are +disabled.
+ +GetScreen returns the screen that the window is on
+ +GetZoom returns the current zoom level of the window.
+ +Height returns the height of the window
+ +Hide hides the window.
+ +IsFocused returns true if the window is currently focused
+ +IsFullscreen returns true if the window is fullscreen
+ +IsMaximised returns true if the window is maximised
+ +IsMinimised returns true if the window is minimised
+ +IsVisible returns true if the window is visible
+ +Maximise maximises the window. Min/Max size constraints are disabled.
+ +Minimise minimises the window.
+ +Name returns the name of the window
+ +NativeWindowHandle returns the platform native window handle for the window.
+ +func (w *WebviewWindow) On(eventType events.WindowEventType, callback func(event *WindowEvent)) func()
+On registers a callback for the given window event
+ +RegisterContextMenu registers a context menu and assigns it the given name.
+ +func (w *WebviewWindow) RegisterHook(eventType events.WindowEventType, callback func(event *WindowEvent)) func()
+RegisterHook registers a hook for the given window event
+ +RelativePosition returns the relative position of the window to the screen
+ +Reload reloads the page assets
+ +Resizable returns true if the window is resizable.
+ +Restore restores the window to its previous state if it was previously +minimised, maximised or fullscreen.
+ +SetAlwaysOnTop sets the window to be always on top.
+ +SetBackgroundColour sets the background colour of the window
+ +SetFrameless removes the window frame and title bar
+ +SetHTML sets the HTML of the window to the given html string.
+ +SetMaxSize sets the maximum size of the window.
+ +SetMinSize sets the minimum size of the window.
+ +SetRelativePosition sets the position of the window.
+ +SetResizable sets whether the window is resizable.
+ +SetSize sets the size of the window
+ +SetTitle sets the title of the window
+ +SetZoom sets the zoom level of the window.
+ +Show shows the window.
+ +Size returns the size of the window
+ +ToggleFullscreen toggles the window between fullscreen and normal
+ +UnFullscreen un-fullscreens the window.
+ +UnMaximise un-maximises the window.
+ +UnMinimise un-minimises the window. Min/Max size constraints are re-enabled.
+ +Width returns the width of the window
+ +ZoomIn increases the zoom level of the webview content
+ +ZoomOut decreases the zoom level of the webview content
+ +ZoomReset resets the zoom level of the webview content to 100%
+ +type WebviewWindowOptions struct {
+ // Name is a unique identifier that can be given to a window.
+ Name string
+
+ // Title is the title of the window.
+ Title string
+
+ // Width is the starting width of the window.
+ Width int
+
+ // Height is the starting height of the window.
+ Height int
+
+ // AlwaysOnTop will make the window float above other windows.
+ AlwaysOnTop bool
+
+ // URL is the URL to load in the window.
+ URL string
+
+ // DisableResize will disable the ability to resize the window.
+ DisableResize bool
+
+ // Frameless will remove the window frame.
+ Frameless bool
+
+ // MinWidth is the minimum width of the window.
+ MinWidth int
+
+ // MinHeight is the minimum height of the window.
+ MinHeight int
+
+ // MaxWidth is the maximum width of the window.
+ MaxWidth int
+
+ // MaxHeight is the maximum height of the window.
+ MaxHeight int
+
+ // StartState indicates the state of the window when it is first shown.
+ // Default: WindowStateNormal
+ StartState WindowState
+
+ // Centered will center the window on the screen.
+ Centered bool
+
+ // BackgroundType is the type of background to use for the window.
+ // Default: BackgroundTypeSolid
+ BackgroundType BackgroundType
+
+ // BackgroundColour is the colour to use for the window background.
+ BackgroundColour RGBA
+
+ // HTML is the HTML to load in the window.
+ HTML string
+
+ // JS is the JavaScript to load in the window.
+ JS string
+
+ // CSS is the CSS to load in the window.
+ CSS string
+
+ // X is the starting X position of the window.
+ X int
+
+ // Y is the starting Y position of the window.
+ Y int
+
+ // TransparentTitlebar will make the titlebar transparent.
+ // TODO: Move to mac window options
+ FullscreenButtonEnabled bool
+
+ // Hidden will hide the window when it is first created.
+ Hidden bool
+
+ // Zoom is the zoom level of the window.
+ Zoom float64
+
+ // ZoomControlEnabled will enable the zoom control.
+ ZoomControlEnabled bool
+
+ // EnableDragAndDrop will enable drag and drop.
+ EnableDragAndDrop bool
+
+ // OpenInspectorOnStartup will open the inspector when the window is first shown.
+ OpenInspectorOnStartup bool
+
+ // Mac options
+ Mac MacWindow
+
+ // Windows options
+ Windows WindowsWindow
+
+ // Focused indicates the window should be focused when initially shown
+ Focused bool
+
+ // ShouldClose is called when the window is about to close.
+ // Return true to allow the window to close, or false to prevent it from closing.
+ ShouldClose func(window *WebviewWindow) bool
+
+ // If true, the window's devtools will be available (default true in builds without the `production` build tag)
+ DevToolsEnabled bool
+
+ // If true, the window's default context menu will be disabled (default false)
+ DefaultContextMenuDisabled bool
+
+ // KeyBindings is a map of key bindings to functions
+ KeyBindings map[string]func(window *WebviewWindow)
+}
+type WindowAttachConfig struct {
+ // Window is the window to attach to the system tray. If it's null, the request to attach will be ignored.
+ Window *WebviewWindow
+
+ // Offset indicates the gap in pixels between the system tray and the window
+ Offset int
+
+ // Debounce is used by Windows to indicate how long to wait before responding to a mouse
+ // up event on the notification icon. See https://stackoverflow.com/questions/4585283/alternate-showing-hiding-window-when-notify-icon-is-clicked
+ Debounce time.Duration
+ // contains filtered or unexported fields
+}
+const (
+ WindowStateNormal WindowState = iota
+ WindowStateMinimised
+ WindowStateMaximised
+ WindowStateFullscreen
+)
+WindowsOptions contains options for Windows applications.
+type WindowsOptions struct {
+
+ // WndProcInterceptor is a function that will be called for every message sent in the application.
+ // Use this to hook into the main message loop. This is useful for handling custom window messages.
+ // If `shouldReturn` is `true` then `returnCode` will be returned by the main message loop.
+ // If `shouldReturn` is `false` then returnCode will be ignored and the message will be processed by the main message loop.
+ WndProcInterceptor func(hwnd uintptr, msg uint32, wParam, lParam uintptr) (returnCode uintptr, shouldReturn bool)
+
+ // DisableQuitOnLastWindowClosed disables the auto quit of the application if the last window has been closed.
+ DisableQuitOnLastWindowClosed bool
+
+ // Path where the WebView2 stores the user data. If empty %APPDATA%\[BinaryName.exe] will be used.
+ // If the path is not valid, a messagebox will be displayed with the error and the app will exit with error code.
+ WebviewUserDataPath string
+
+ // Path to the directory with WebView2 executables. If empty WebView2 installed in the system will be used.
+ WebviewBrowserPath string
+}
+type WindowsWindow struct {
+ // Select the type of translucent backdrop. Requires Windows 11 22621 or later.
+ // Only used when window's `BackgroundType` is set to `BackgroundTypeTranslucent`.
+ // Default: Auto
+ BackdropType BackdropType
+
+ // Disable the icon in the titlebar
+ // Default: false
+ DisableIcon bool
+
+ // Theme (Dark / Light / SystemDefault)
+ // Default: SystemDefault - The application will follow system theme changes.
+ Theme Theme
+
+ // Specify custom colours to use for dark/light mode
+ // Default: nil
+ CustomTheme *ThemeSettings
+
+ // Disable all window decorations in Frameless mode, which means no "Aero Shadow" and no "Rounded Corner" will be shown.
+ // "Rounded Corners" are only available on Windows 11.
+ // Default: false
+ DisableFramelessWindowDecorations bool
+
+ // WindowMask is used to set the window shape. Use a PNG with an alpha channel to create a custom shape.
+ // Default: nil
+ WindowMask []byte
+
+ // WindowMaskDraggable is used to make the window draggable by clicking on the window mask.
+ // Default: false
+ WindowMaskDraggable bool
+
+ // WebviewGpuIsDisabled is used to enable / disable GPU acceleration for the webview
+ // Default: false
+ WebviewGpuIsDisabled bool
+
+ // ResizeDebounceMS is the amount of time to debounce redraws of webview2
+ // when resizing the window
+ // Default: 0
+ ResizeDebounceMS uint16
+
+ // Disable the menu bar for this window
+ // Default: false
+ DisableMenu bool
+
+ // Event mapping for the window. This allows you to define a translation from one event to another.
+ // Default: nil
+ EventMapping map[events.WindowEventType]events.WindowEventType
+
+ // HiddenOnTaskbar hides the window from the taskbar
+ // Default: false
+ HiddenOnTaskbar bool
+
+ // EnableSwipeGestures enables swipe gestures for the window
+ // Default: false
+ EnableSwipeGestures bool
+
+ // EnableFraudulentWebsiteWarnings will enable warnings for fraudulent websites.
+ // Default: false
+ EnableFraudulentWebsiteWarnings bool
+
+ // Menu is the menu to use for the window.
+ Menu *Menu
+}
+These methods are utility functions to run code on the main thread. This is +required when you want to run custom code on the UI thread.
+API: InvokeSync(fn func())
This function runs the passed function (fn) synchronously. It uses a WaitGroup
+(wg) to ensure that the main thread waits for the fn function to finish
+before it continues. If a panic occurs inside fn, it will be passed to the
+handler function PanicHandler, defined in the application options.
API: InvokeSyncWithResult[T any](fn func() T) (res T)
This function works similarly to InvokeSync(fn func()), however, it yields a
+result. Use this for calling any function with a single return.
API: InvokeSyncWithError(fn func() error) (err error)
This function runs fn synchronously and returns any error that fn produces.
+Note that this function will recover from a panic if one occurs during fn's
+execution.
API:
+InvokeSyncWithResultAndError[T any](fn func() (T, error)) (res T, err error)
This function runs fn synchronously and returns both a result of type T and
+an error.
API: InvokeAsync(fn func())
This function runs fn asynchronously. It runs the given function on the main
+thread. If a panic occurs inside fn, it will be passed to the handler function
+PanicHandler, defined in the application options.
Note: These functions will block execution until fn has finished. It's
+critical to ensure that fn doesn't block. If you need to run a function that
+blocks, use InvokeAsync instead.
Menus can be created and added to the application. They can be used to create +context menus, system tray menus and application menus.
+To create a new menu, call:
+ +The following operations are then available on the Menu type:
API: Add(label string) *MenuItem
This method takes a label of type string as an input and adds a new
+MenuItem with the given label to the menu. It returns the MenuItem added.
API: AddSeparator()
This method adds a new separator MenuItem to the menu.
API: AddCheckbox(label string, enabled bool) *MenuItem
This method takes a label of type string and enabled of type bool as
+inputs and adds a new checkbox MenuItem with the given label and enabled state
+to the menu. It returns the MenuItem added.
API: AddRadio(label string, enabled bool) *MenuItem
This method takes a label of type string and enabled of type bool as
+inputs and adds a new radio MenuItem with the given label and enabled state to
+the menu. It returns the MenuItem added.
API: Update()
This method processes any radio groups and updates the menu if a menu +implementation is not initialized.
+API: AddSubmenu(s string) *Menu
This method takes a s of type string as input and adds a new submenu
+MenuItem with the given label to the menu. It returns the submenu added.
API: AddRole(role Role) *Menu
This method takes role of type Role as input, adds it to the menu if it is
+not nil and returns the Menu.
API: SetLabel(label string)
This method sets the label of the Menu.
The system tray houses notification area on a desktop environment, which can +contain both icons of currently-running applications and specific system +notifications.
+You create a system tray by calling app.NewSystemTray():
The following methods are available on the SystemTray type:
API: SetLabel(label string)
The SetLabel method sets the tray's label.
API: Label() string
The Label method retrieves the tray's label.
API: PositionWindow(*WebviewWindow, offset int) error
The PositionWindow method calls both AttachWindow and WindowOffset
+methods.
API: SetIcon(icon []byte) *SystemTray
The SetIcon method sets the system tray's icon.
API: SetDarkModeIcon(icon []byte) *SystemTray
The SetDarkModeIcon method sets the system tray's icon when in dark mode.
API: SetMenu(menu *Menu) *SystemTray
The SetMenu method sets the system tray's menu.
API: Destroy()
The Destroy method destroys the system tray instance.
API: OnClick(handler func()) *SystemTray
The OnClick method sets the function to execute when the tray icon is clicked.
API: OnRightClick(handler func()) *SystemTray
The OnRightClick method sets the function to execute when right-clicking the
+tray icon.
API: OnDoubleClick(handler func()) *SystemTray
The OnDoubleClick method sets the function to execute when double-clicking the
+tray icon.
API: OnRightDoubleClick(handler func()) *SystemTray
The OnRightDoubleClick method sets the function to execute when right
+double-clicking the tray icon.
API: AttachWindow(window *WebviewWindow) *SystemTray
The AttachWindow method attaches a window to the system tray. The window will
+be shown when the system tray icon is clicked.
API: WindowOffset(offset int) *SystemTray
The WindowOffset method sets the gap in pixels between the system tray and the
+window.
API: WindowDebounce(debounce time.Duration) *SystemTray
The WindowDebounce method sets a debounce time. In the context of Windows,
+this is used to specify how long to wait before responding to a mouse up event
+on the notification icon.
API: OpenMenu()
The OpenMenu method opens the menu associated with the system tray.
To create a window, use +Application.NewWebviewWindow or +Application.NewWebviewWindowWithOptions. +The former creates a window with default options, while the latter allows you to +specify custom options.
+These methods are callable on the returned WebviewWindow object:
+API: SetTitle(title string) *WebviewWindow
This method updates the window title to the provided string. It returns the +WebviewWindow object, allowing for method chaining.
+API: Name() string
This function returns the name of the WebviewWindow.
+API: SetSize(width, height int) *WebviewWindow
This method sets the size of the WebviewWindow to the provided width and height +parameters. If the dimensions provided exceed the constraints, they are adjusted +appropriately.
+API: SetAlwaysOnTop(b bool) *WebviewWindow
This function sets the window to stay on top based on the boolean flag provided.
+API: Show() *WebviewWindow
Show method is used to make the window visible. If the window is not running,
+it first invokes the run method to start the window and then makes it visible.
API: Hide() *WebviewWindow
Hide method is used to hide the window. It sets the hidden status of the
+window to true and emits the window hide event.
API: SetURL(s string) *WebviewWindow
SetURL method is used to set the URL of the window to the given URL string.
API: SetZoom(magnification float64) *WebviewWindow
SetZoom method sets the zoom level of the window content to the provided
+magnification level.
API: GetZoom() float64
GetZoom function returns the current zoom level of the window content.
API: GetScreen() (*Screen, error)
GetScreen method returns the screen on which the window is displayed.
API: SetFrameless(frameless bool) *WebviewWindow
This function is used to remove the window frame and title bar. It toggles the +framelessness of the window according to the boolean value provided (true for +frameless, false for framed).
+API: RegisterContextMenu(name string, menu *Menu)
This function is used to register a context menu and assigns it the given name.
+API: NativeWindowHandle() (uintptr, error)
This function is used to fetch the platform native window handle for the window.
+API: Focus()
This function is used to focus the window.
+API: SetEnabled(enabled bool)
This function is used to enable/disable the window based on the provided boolean +value.
+API: SetAbsolutePosition(x int, y int)
This function sets the absolute position of the window in the screen.
+ + + + + + + + + + + + + +Note
+This is currently an unsorted brain dump of changes. It will be
+organised into a more readable format soon.
+The application options have been revised since v2.
+In v3, there are 3 types of events:
+Application events are events that are emitted by the application. These events
+include native events such as ApplicationDidFinishLaunching on macOS.
Window events are events that are emitted by a window. These events include
+native events such as WindowDidBecomeMain on macOS. Common events are also
+defined, so they work cross-platform, e.g. WindowClosing.
Events that the user defines are called WailsEvents. This is to differentiate
+them from the Event object that is used to communicate with the browser.
+WailsEvents are now objects that encapsulate all the details of an event. This
+includes the event name, the data, and the source of the event.
The data associated with a WailsEvent is now a single value. If multiple values +are required, then a struct can be used.
+Emit function signatureThe signatures events callbacks (as used by On, Once & OnMultiple) have
+changed. In v2, the callback function received optional data. In v3, the
+callback function receives a WailsEvent object that contains all data related
+to the event.
Similarly, the Emit function has changed. Instead of taking a name and
+optional data, it now takes a single WailsEvent object that it will emit.
Off and OffAllIn v2, Off and OffAll calls would remove events in both JS and Go. Due to
+the multi-window nature of v3, this has been changed so that these methods only
+apply to the context they are called in. For example, if you call Off in a
+window, it will only remove events for that window. If you use Off in Go, it
+will only remove events for Go.
Event Hooks are a new feature in v3. They allow you to hook into the event
+system and perform actions when certain events are emitted. For example, you can
+hook into the WindowClosing event and perform some cleanup before the window
+closes. Hooks can be registered at the application level or at the window level
+using RegisterHook. Application level are for application events. Window level
+hooks will only be called for the window they are registered with.
Logging in v2 was confusing as both application logs and system (internal) logs +were using the same logger. We have simplified this as follows:
+slog logger. This is
+ configured using the logger option in the application options. By default,
+ this uses the tint logger.log plugin which
+ utilises slog under the hood. This plugin provides a simple API for logging
+ to the console. It is available in both Go and JS.When emitting an event in Go, it will dispatch the event to local Go listeners +and also each window in the application. When emitting an event in JS, it now +sends the event to the application. This will be processed as if it was emitted +in Go, however the sender ID will be that of the window.
+The Window API has largely remained the same, however the methods are now on an +instance of a window rather than the runtime. Some notable differences are:
+AbsolutePosition and ToggleDevTools.The clipboard API has been simplified. There is now a single Clipboard object
+that can be used to read and write to the clipboard. The Clipboard object is
+available in both Go and JS. SetText() to set the text and Text() to get the
+text.
Bindings work in a similar way to v2, by providing a means to bind struct
+methods to the frontend. These can be called in the frontend using the binding
+wrappers generated by the wails3 generate bindings command:
// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+import { main } from "./models";
+
+window.go = window.go || {};
+window.go.main = {
+ GreetService: {
+ /**
+ * GreetService.Greet
+ * Greet greets a person
+ * @param name {string}
+ * @returns {Promise<string>}
+ **/
+ Greet: function (name) {
+ wails.CallByID(1411160069, ...Array.prototype.slice.call(arguments, 0));
+ },
+
+ /**
+ * GreetService.GreetPerson
+ * GreetPerson greets a person
+ * @param person {main.Person}
+ * @returns {Promise<string>}
+ **/
+ GreetPerson: function (person) {
+ wails.CallByID(4021313248, ...Array.prototype.slice.call(arguments, 0));
+ },
+ },
+};
+Bound methods are obfuscated by default, and are identified using uint32 IDs,
+calculated using the
+FNV hashing algorithm.
+This is to prevent the method name from being exposed in production builds. In
+debug mode, the method IDs are logged along with the calculated ID of the method
+to aid in debugging. If you wish to add an extra layer of obfuscation, you can
+use the BindAliases option. This allows you to specify a map of alias IDs to
+method IDs. When the frontend calls a method using an ID, the method ID will be
+looked up in the alias map first for a match. If it does not find it, it assumes
+it's a standard method ID and tries to find the method in the usual way.
Example:
+ app := application.New(application.Options{
+ Bind: []any{
+ &GreetService{},
+ },
+ BindAliases: map[uint32]uint32{
+ 1: 1411160069,
+ 2: 4021313248,
+ },
+ Assets: application.AssetOptions{
+ FS: assets,
+ },
+ Mac: application.MacOptions{
+ ApplicationShouldTerminateAfterLastWindowClosed: true,
+ },
+ })
+We can now call using this alias in the frontend: wails.Call(1, "world!").
If you don't mind your calls being available in plain text in your binary and
+have no intention of using garble, then
+you can use the insecure wails.CallByName() method. This method takes the
+fully qualified name of the method to call and the arguments to pass to it.
+Example:
```go
+wails.CallByName("main.GreetService.Greet", "world!")
+```
+Danger
+This is only provided as a convenience method for development. It is not recommended to use this in production.
+Dialogs are now available in JavaScript!
+Dialog buttons in Windows are not configurable and are constant depending on the
+type of dialog. To trigger a callback when a button is pressed, create a button
+with the same name as the button you wish to have the callback attached to.
+Example: Create a button with the label Ok and use OnClick() to set the
+callback method:
dialog := app.QuestionDialog().
+ SetTitle("Update").
+ SetMessage("The cancel button is selected when pressing escape")
+ ok := dialog.AddButton("Ok")
+ ok.OnClick(func() {
+ // Do something
+ })
+ no := dialog.AddButton("Cancel")
+ dialog.SetDefaultButton(ok)
+ dialog.SetCancelButton(no)
+ dialog.Show()
+Native drag and drop can be enabled per-window. Simply set the
+EnableDragAndDrop window config option to true and the window will allow
+files to be dragged onto it. When this happens, the events.FilesDropped event
+will be emitted. The filenames can then be retrieved from the
+WindowEvent.Context() using the DroppedFiles() method. This returns a slice
+of strings containing the filenames.
Context menus are contextual menus that are shown when the user right-clicks on
+an element. Creating a context menu is the same as creating a standard menu , by
+using app.NewMenu(). To make the context menu available to a window, call
+window.RegisterContextMenu(name, menu). The name will be the id of the context
+menu and used by the frontend.
To indicate that an element has a context menu, add the data-contextmenu
+attribute to the element. The value of this attribute should be the name of a
+context menu previously registered with the window.
It is possible to register a context menu at the application level, making it
+available to all windows. This can be done using
+app.RegisterContextMenu(name, menu). If a context menu cannot be found at the
+window level, the application context menus will be checked. A demo of this can
+be found in v3/examples/contextmenus.
The Wails Markup Language is a simple markup language that allows you to add +functionality to standard HTML elements without the use of Javascript.
+The following tags are currently supported:
+data-wml-eventThis specifies that a Wails event will be emitted when the element is clicked. +The value of the attribute should be the name of the event to emit.
+Example:
+ +Sometimes you need the user to confirm an action. This can be done by adding the
+data-wml-confirm attribute to the element. The value of this attribute will be
+the message to display to the user.
Example:
+<button data-wml-event="delete-all-items" data-wml-confirm="Are you sure?">
+ Delete All Items
+</button>
+data-wml-windowAny wails.window method can be called by adding the data-wml-window
+attribute to an element. The value of the attribute should be the name of the
+method to call. The method name should be in the same case as the method.
data-wml-triggerThis attribute specifies which javascript event should trigger the action. The
+default is click.
Wails 3 comes with a built-in systray. This is a fully featured systray that has +been designed to be as simple as possible to use. It is possible to set the +icon, tooltip and menu of the systray. It is possible to also "attach" a window +to the systray. Doing this will provide the following functionality:
+On macOS, if there is no attached window, the systray will use the default +method of displaying the menu (any button). If there is an attached window but +no menu, the systray will toggle the window regardless of the button pressed.
+Plugins are a way to extend the functionality of your Wails application.
+Plugins are standard Go structure that adhere to the following interface:
+type Plugin interface {
+ Name() string
+ Init(*application.App) error
+ Shutdown()
+ CallableByJS() []string
+ InjectJS() string
+}
+The Name() method returns the name of the plugin. This is used for logging
+purposes.
The Init(*application.App) error method is called when the plugin is loaded.
+The *application.App parameter is the application that the plugin is being
+loaded into. Any errors will prevent the application from starting.
The Shutdown() method is called when the application is shutting down.
The CallableByJS() method returns a list of exported functions that can be
+called from the frontend. These method names must exactly match the names of the
+methods exported by the plugin.
The InjectJS() method returns JavaScript that should be injected into all
+windows as they are created. This is useful for adding custom JavaScript
+functions that complement the plugin.
In Go, enums are often defined as a type and a set of constants. For example:
+ +Due to incompatibility between Go and JavaScript, custom types cannot be used in +this way. The best strategy is to use a type alias for float64:
+ +In Javascript, you can then use the following:
+ +float64? Can't we use int?int. Everything is a
+ number, which translates to float64 in Go. There are also restrictions
+ on casting types in Go's reflection package, which means using int doesn't
+ work.In v2, this was a pointer to an RGBA struct. In v3, this is an RGBA struct
+value.
This flag has been removed. Now there is a BackgroundType flag that can be
+used to set the type of background the window should have. This flag can be set
+to any of the following values:
BackgroundTypeSolid - The window will have a solid backgroundBackgroundTypeTransparent - The window will have a transparent backgroundBackgroundTypeTranslucent - The window will have a translucent backgroundOn Windows, if the BackgroundType is set to BackgroundTypeTranslucent, the
+type of translucency can be set using the BackdropType flag in the
+WindowsWindow options. This can be set to any of the following values:
Auto - The window will use an effect determined by the systemNone - The window will have no backgroundMica - The window will use the Mica effectAcrylic - The window will use the acrylic effectTabbed - The window will use the tabbed effectIf this is set, the WndProc will be intercepted and the function will be called. +This allows you to handle Windows messages directly. The function should have +the following signature:
+ +The shouldReturn value should be set to true if the returnValue should be
+returned by the main wndProc method. If it is set to false, the return value
+will be ignored and the message will continue to be processed by the main
+wndProc method.
In v2, there was the HideWindowOnClose flag to hide the window when it closed.
+There was a logical overlap between this flag and the OnBeforeClose callback.
+In v3, the HideWindowOnClose flag has been removed and the OnBeforeClose
+callback has been renamed to ShouldClose. The ShouldClose callback is called
+when the user attempts to close a window. If the callback returns true, the
+window will close. If it returns false, the window will not close. This can be
+used to hide the window instead of closing it.
In v2, the --wails-drag attribute was used to indicate that an element could
+be used to drag the window. In v3, this has been replaced with
+--webkit-app-region to be more in line with the way other frameworks handle
+this. The --webkit-app-region attribute can be set to any of the following
+values:
drag - The element can be used to drag the windowno-drag - The element cannot be used to drag the windowWe would have ideally liked to use app-region, however this is not supported
+by the getComputedStyle call on webkit on macOS.
Note
+This guide is a work in progress.
+Thanks for wanting to help out with development of Wails! This guide will help +you get started.
+v3-alpha branch.Install the CLI: cd v3/cmd/wails3 && go install
Optional: If you are wanting to use the build system to build frontend code, + you will need to install npm.
+For simple programs, you can use the standard go build command. It's also
+possible to use go run.
Wails also comes with a build system that can be used to build more complex
+projects. It utilises the awesome Task build system. For
+more information, check out the task homepage or run wails task --help.
The project has the following structure:
+```
+v3
+├── cmd/wails3 // CLI
+├── examples // Examples of Wails apps
+├── internal // Internal packages
+| ├── runtime // The Wails JS runtime
+| └── templates // The supported project templates
+├── pkg
+| ├── application // The core Wails library
+| └── events // The event definitions
+| └── mac // macOS specific code used by plugins
+| └── w32 // Windows specific code
+├── plugins // Supported plugins
+├── tasks // General tasks
+└── Taskfile.yaml // Development tasks configuration
+```
+We are currently tracking known issues and tasks in the +Alpha Todo List. If you want to +help out, please check this list and follow the instructions in the +Feedback page.
+The preferred way to add window functionality is to add a new function to the
+pkg/application/webview_window.go file. This should implement all the
+functionality required for all platforms. Any platform specific code should be
+called via a webviewWindowImpl interface method. This interface is implemented
+by each of the target platforms to provide the platform specific functionality.
+In some cases, this may do nothing. Once you've added the interface method,
+ensure each platform implements it. A good example of this is the SetMinSize
+method.
webview_window_darwin.gowebview_window_windows.gowebview_window_linux.goMost, if not all, of the platform specific code should be run on the main
+thread. To simplify this, there are a number of invokeSync methods defined in
+application.go.
The runtime is located in v3/internal/runtime. When the runtime is updated,
+the following steps need to be taken:
Events are defined in v3/pkg/events. When adding a new event, the following
+steps need to be taken:
events.txt filewails3 task events:generateThere are a number of types of events: platform specific application and window +events + common events. The common events are useful for cross-platform event +handling, but you aren't limited to the "lowest common denominator". You can use +the platform specific events if you need to.
+When adding a common event, ensure that the platform specific events are mapped.
+An example of this is in window_webview_darwin.go:
// Translate ShouldClose to common WindowClosing event
+ w.parent.On(events.Mac.WindowShouldClose, func(_ *WindowEventContext) {
+ w.parent.emit(events.Common.WindowClosing)
+ })
+NOTE: We may try to automate this in the future by adding the mapping to the +event definition.
+Plugins are a way to extend the functionality of your Wails application.
+Plugins are standard Go structure that adhere to the following interface:
+type Plugin interface {
+ Name() string
+ Init(*application.App) error
+ Shutdown()
+ CallableByJS() []string
+ InjectJS() string
+}
+The Name() method returns the name of the plugin. This is used for logging
+purposes.
The Init(*application.App) error method is called when the plugin is loaded.
+The *application.App parameter is the application that the plugin is being
+loaded into. Any errors will prevent the application from starting.
The Shutdown() method is called when the application is shutting down.
The CallableByJS() method returns a list of exported functions that can be
+called from the frontend. These method names must exactly match the names of the
+methods exported by the plugin.
The InjectJS() method returns JavaScript that should be injected into all
+windows as they are created. This is useful for adding custom JavaScript
+functions that complement the plugin.
The built-in plugins can be found in the v3/plugins directory. Check them out
+for inspiration.
The Wails CLI uses the Task build system. It is imported
+as a library and used to run the tasks defined in Taskfile.yaml. The main
+interfacing with Task happens in v3/internal/commands/task.go.
To check if there's an upgrade for Taskfile, run wails3 task -version and
+check against the Task website.
To upgrade the version of Taskfile used, run:
+ +If there are incompatibilities then they should appear in the
+v3/internal/commands/task.go file.
Usually the best way to fix incompatibilities is to clone the task repo at
+https://github.com/go-task/task and look at the git history to determine what
+has changed and why.
To check all changes have worked correctly, re-install the CLI and check the +version again:
+ +Make sure that all PRs have a ticket associated with them providing context to
+the change. If there is no ticket, please create one first. Ensure that all PRs
+have updated the CHANGELOG.md file with the changes made. The CHANGELOG.md file
+is located in the mkdocs-website/docs directory.
The Wails CLI uses the Task build system. It is imported
+as a library and used to run the tasks defined in Taskfile.yaml. The main
+interfacing with Task happens in v3/internal/commands/task.go.
To check if there's an upgrade for Taskfile, run wails3 task -version and
+check against the Task website.
To upgrade the version of Taskfile used, run:
+ +If there are incompatibilities then they should appear in the
+v3/internal/commands/task.go file.
Usually the best way to fix incompatibilities is to clone the task repo at
+https://github.com/go-task/task and look at the git history to determine what
+has changed and why.
To check all changes have worked correctly, re-install the CLI and check the +version again:
+ + + + + + + + + + + + + + +Status of features in v3.
+Note
+This list is a mixture of public and internal API support.<br/>
+It is not complete and probably not up to date.
+Application interface methods
+| Method | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| run() error | +Y | +Y | +Y | ++ |
| destroy() | ++ | Y | +Y | ++ |
| setApplicationMenu(menu *Menu) | +Y | +Y | +Y | ++ |
| name() string | ++ | Y | +Y | ++ |
| getCurrentWindowID() uint | +Y | +Y | +Y | ++ |
| showAboutDialog(name string, description string, icon []byte) | ++ | Y | +Y | ++ |
| setIcon(icon []byte) | +- | +Y | +Y | ++ |
| on(id uint) | ++ | + | Y | ++ |
| dispatchOnMainThread(fn func()) | +Y | +Y | +Y | ++ |
| hide() | +Y | +Y | +Y | ++ |
| show() | +Y | +Y | +Y | ++ |
| getPrimaryScreen() (*Screen, error) | ++ | Y | +Y | ++ |
| getScreens() ([]*Screen, error) | ++ | Y | +Y | ++ |
Webview Window Interface Methods
+| Method | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| center() | +Y | +Y | +Y | ++ |
| close() | +y | +Y | +Y | ++ |
| destroy() | ++ | Y | +Y | ++ |
| execJS(js string) | +y | +Y | +Y | ++ |
| focus() | +Y | +Y | ++ | + |
| forceReload() | ++ | Y | +Y | ++ |
| fullscreen() | +Y | +Y | +Y | ++ |
| getScreen() (*Screen, error) | +y | +Y | +Y | ++ |
| getZoom() float64 | ++ | Y | +Y | ++ |
| height() int | +Y | +Y | +Y | ++ |
| hide() | +Y | +Y | +Y | ++ |
| isFullscreen() bool | +Y | +Y | +Y | ++ |
| isMaximised() bool | +Y | +Y | +Y | ++ |
| isMinimised() bool | +Y | +Y | +Y | ++ |
| maximise() | +Y | +Y | +Y | ++ |
| minimise() | +Y | +Y | +Y | ++ |
| nativeWindowHandle() (uintptr, error) | +Y | +Y | +Y | ++ |
| on(eventID uint) | +y | ++ | Y | ++ |
| openContextMenu(menu Menu, data ContextMenuData) | +y | +Y | +Y | ++ |
| relativePosition() (int, int) | +Y | +Y | +Y | ++ |
| reload() | +y | +Y | +Y | ++ |
| run() | +Y | +Y | +Y | ++ |
| setAlwaysOnTop(alwaysOnTop bool) | +Y | +Y | +Y | ++ |
| setBackgroundColour(color RGBA) | +Y | +Y | +Y | ++ |
| setEnabled(bool) | ++ | Y | +Y | ++ |
| setFrameless(bool) | ++ | Y | +Y | ++ |
| setFullscreenButtonEnabled(enabled bool) | +- | +Y | +Y | +There is no fullscreen button in Windows | +
| setHTML(html string) | +Y | +Y | +Y | ++ |
| setMaxSize(width, height int) | +Y | +Y | +Y | ++ |
| setMinSize(width, height int) | +Y | +Y | +Y | ++ |
| setRelativePosition(x int, y int) | +Y | +Y | +Y | ++ |
| setResizable(resizable bool) | +Y | +Y | +Y | ++ |
| setSize(width, height int) | +Y | +Y | +Y | ++ |
| setTitle(title string) | +Y | +Y | +Y | ++ |
| setURL(url string) | +Y | +Y | +Y | ++ |
| setZoom(zoom float64) | +Y | +Y | +Y | ++ |
| show() | +Y | +Y | +Y | ++ |
| size() (int, int) | +Y | +Y | +Y | ++ |
| toggleDevTools() | +Y | +Y | +Y | ++ |
| unfullscreen() | +Y | +Y | +Y | ++ |
| unmaximise() | +Y | +Y | +Y | ++ |
| unminimise() | +Y | +Y | +Y | ++ |
| width() int | +Y | +Y | +Y | ++ |
| zoom() | ++ | Y | +Y | ++ |
| zoomIn() | +Y | +Y | +Y | ++ |
| zoomOut() | +Y | +Y | +Y | ++ |
| zoomReset() | +Y | +Y | +Y | ++ |
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Quit | +Y | +Y | +Y | ++ |
| Hide | +Y | +Y | +Y | ++ |
| Show | +Y | ++ | Y | ++ |
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Info | +Y | +Y | +Y | ++ |
| Warning | +Y | +Y | +Y | ++ |
| Error | +Y | +Y | +Y | ++ |
| Question | +Y | +Y | +Y | ++ |
| OpenFile | +Y | +Y | +Y | ++ |
| SaveFile | +Y | +Y | +Y | ++ |
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| SetText | +Y | +Y | +Y | ++ |
| Text | +Y | +Y | +Y | ++ |
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| OpenContextMenu | +Y | +Y | +Y | ++ |
| On By Default | ++ | + | + | + |
| Control via HTML | +Y | ++ | + | + |
The default context menu is enabled by default for all elements that are
+contentEditable: true, <input> or <textarea> tags or have the
+--default-contextmenu: true style set. The --default-contextmenu: show style
+will always show the context menu The --default-contextmenu: hide style will
+always hide the context menu
Anything nested under a tag with --default-contextmenu: hide style will not
+show the context menu unless it is explicitly set with
+--default-contextmenu: show.
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| GetAll | +Y | +Y | +Y | ++ |
| GetPrimary | +Y | +Y | +Y | ++ |
| GetCurrent | +Y | +Y | +Y | ++ |
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| IsDarkMode | ++ | + | Y | ++ |
Y = Supported U = Untested
+| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Center | +Y | +Y | +Y | ++ |
| Focus | +Y | +Y | ++ | + |
| FullScreen | +Y | +Y | +Y | ++ |
| GetZoom | +Y | +Y | +Y | +Get current view scale | +
| Height | +Y | +Y | +Y | ++ |
| Hide | +Y | +Y | +Y | ++ |
| Maximise | +Y | +Y | +Y | ++ |
| Minimise | +Y | +Y | +Y | ++ |
| RelativePosition | +Y | +Y | +Y | ++ |
| Screen | +Y | +Y | +Y | +Get screen for window | +
| SetAlwaysOnTop | +Y | +Y | +Y | ++ |
| SetBackgroundColour | +Y | +Y | +Y | +https://github.com/MicrosoftEdge/WebView2Feedback/issues/1621#issuecomment-938234294 | +
| SetEnabled | +Y | +U | +- | +Set the window to be enabled/disabled | +
| SetMaxSize | +Y | +Y | +Y | ++ |
| SetMinSize | +Y | +Y | +Y | ++ |
| SetRelativePosition | +Y | +Y | +Y | ++ |
| SetResizable | +Y | +Y | +Y | ++ |
| SetSize | +Y | +Y | +Y | ++ |
| SetTitle | +Y | +Y | +Y | ++ |
| SetZoom | +Y | +Y | +Y | +Set view scale | +
| Show | +Y | +Y | +Y | ++ |
| Size | +Y | +Y | +Y | ++ |
| UnFullscreen | +Y | +Y | +Y | ++ |
| UnMaximise | +Y | +Y | +Y | ++ |
| UnMinimise | +Y | +Y | +Y | ++ |
| Width | +Y | +Y | +Y | ++ |
| ZoomIn | +Y | +Y | +Y | +Increase view scale | +
| ZoomOut | +Y | +Y | +Y | +Decrease view scale | +
| ZoomReset | +Y | +Y | +Y | +Reset view scale | +
A 'Y' in the table below indicates that the option has been tested and is +applied when the window is created. An 'X' indicates that the option is not +supported by the platform.
+| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| AlwaysOnTop | +Y | +Y | ++ | + |
| BackgroundColour | +Y | +Y | ++ | + |
| BackgroundType | ++ | + | + | Acrylic seems to work but the others don't | +
| CSS | +Y | +Y | ++ | + |
| DevToolsEnabled | +Y | +Y | +Y | ++ |
| DisableResize | +Y | +Y | ++ | + |
| EnableDragAndDrop | ++ | Y | ++ | + |
| EnableFraudulentWebsiteWarnings | ++ | + | + | + |
| Focused | +Y | +Y | ++ | + |
| Frameless | +Y | +Y | ++ | + |
| FullscreenButtonEnabled | +Y | ++ | + | + |
| Height | +Y | +Y | ++ | + |
| Hidden | +Y | +Y | ++ | + |
| HTML | +Y | +Y | ++ | + |
| JS | +Y | +Y | ++ | + |
| Mac | +- | +- | ++ | + |
| MaxHeight | +Y | +Y | ++ | + |
| MaxWidth | +Y | +Y | ++ | + |
| MinHeight | +Y | +Y | ++ | + |
| MinWidth | +Y | +Y | ++ | + |
| Name | +Y | +Y | ++ | + |
| OpenInspectorOnStartup | ++ | + | + | + |
| StartState | +Y | ++ | + | + |
| Title | +Y | +Y | ++ | + |
| URL | +Y | +Y | ++ | + |
| Width | +Y | +Y | ++ | + |
| Windows | +Y | +- | +- | ++ |
| X | +Y | +Y | ++ | + |
| Y | +Y | +Y | ++ | + |
| Zoom | ++ | + | + | + |
| ZoomControlEnabled | ++ | + | + | + |
To log or not to log? System logger vs custom logger.
+| Event | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Default Application Menu | +Y | +Y | +Y | ++ |
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Icon | +Y | +Y | +Y | +Windows has default icons for light/dark mode & supports PNG or ICO. | +
| Label | +- | +Y | +Y | ++ |
| Label (ANSI Codes) | +- | ++ | + | + |
| Menu | +Y | +Y | +Y | ++ |
| Method | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| setLabel(label string) | +- | +Y | +Y | ++ |
| run() | +Y | +Y | +Y | ++ |
| setIcon(icon []byte) | +Y | +Y | +Y | ++ |
| setMenu(menu *Menu) | +Y | +Y | +Y | ++ |
| setIconPosition(position int) | +- | +Y | +Y | ++ |
| setTemplateIcon(icon []byte) | +- | +Y | +Y | ++ |
| destroy() | +Y | +Y | +Y | ++ |
| setDarkModeIcon(icon []byte) | +Y | +Y | +Y | +Darkmode isn't handled yet (linux) | +
Mapping native events to cross-platform events.
+| Event | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| WindowWillClose | ++ | + | WindowWillClose | ++ |
| WindowDidClose | ++ | + | + | + |
| WindowDidResize | ++ | + | + | + |
| WindowDidHide | ++ | + | + | + |
| ApplicationWillTerminate | ++ | + | + | + |
... Add more
+Working well.
+Working well.
+Contains a lot needed for development.
+| Mode | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Dark | +Y | ++ | + | + |
| Light | +Y | ++ | + | + |
| System | +Y | ++ | + | + |
TBD
+All templates are working.
+Built-in plugin support:
+| Plugin | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Browser | +Y | ++ | Y | ++ |
| KV Store | +Y | +Y | +Y | ++ |
| Log | +Y | +Y | +Y | ++ |
| Single Instance | +Y | ++ | Y | ++ |
| SQLite | +Y | +Y | +Y | ++ |
| Start at login | +Y | ++ | Y | ++ |
| Server | ++ | + | + | + |
TODO:
+| + | Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Icon Generation | +Y | ++ | Y | ++ |
| Icon Embedding | +Y | ++ | Y | ++ |
| Info.plist | +- | ++ | Y | ++ |
| NSIS Installer | ++ | + | - | ++ |
| Mac bundle | +- | ++ | Y | ++ |
| Windows exe | +Y | ++ | - | ++ |
| Feature | +Windows | +Linux | +Mac | +Notes | +
|---|---|---|---|---|
| Resize | +Y | ++ | Y | ++ |
| Drag | +Y | +Y | +Y | +Linux - can always drag with Meta+left mouse |
+
| Feature | +Default | +Notes | +
|---|---|---|
| Backdrop | +MacBackdropNormal | +Standard solid window | +
| DisableShadow | +false | ++ |
| TitleBar | ++ | Standard window decorations by default | +
| Appearance | +DefaultAppearance | ++ |
| InvisibleTitleBarHeight | +0 | +Creates an invisible title bar for frameless windows | +
| DisableShadow | +false | +Disables the window drop shadow | +
| Feature | +Default | +Notes | +
|---|---|---|
| BackdropType | +Solid | ++ |
| DisableIcon | +false | ++ |
| Theme | +SystemDefault | ++ |
| CustomTheme | +nil | ++ |
| DisableFramelessWindowDecorations | +false | ++ |
| WindowMask | +nil | +Makes the window the contents of the bitmap | +
Implementation details for the functions utilized by the *_linux.go files are
+located in the following files:
By default CGO is utilized to compile the Linux port. This prevents easy +cross-compilation and so the PureGo implementation is also being simultaneously +developed.
+The examples can be compiled using the following command:
+CGO_ENABLED=0 go build -tags purego
+Note: things are currently not working after the refactor
+ + + + + + + + + + + + + +We welcome (and encourage) your feedback! Please search for existing tickets or +posts before creating new ones. Here are the different ways to provide feedback:
+If you find a bug, please let us know by posting into the v3 Alpha Feedback channel on Discord:
+Bug tag.wails doctor in your post.If you have a fix for a bug or an update for documentation, please do the following:
+[v3 alpha].PR tag.If you have a suggestion, please let us know by posting into the v3 Alpha Feedback channel on Discord:
+Suggestion tag.Please feel free to reach out to us on Discord if you have any questions.
+
emoji. Please apply to any posts that are a priority for you.There is a list of known issues & work in progress can be found +here.
+To install the Wails CLI, ensure you have Go 1.21+ +installed and run:
+git clone https://github.com/wailsapp/wails.git
+cd wails
+git checkout v3-alpha
+cd v3/cmd/wails3
+go install
+Wails has a number of common dependencies that are required before installation:
+Download Go from the Go Downloads Page.
+Ensure that you follow the official Go installation instructions. You will also need to ensure that your PATH environment variable also includes the path to your ~/go/bin directory. Restart your terminal and do the following checks:
go version~/go/bin is in your PATH variable: echo $PATH | grep go/binAlthough Wails doesn't require npm to be installed, it is needed if you want to use the bundled templates.
+Download the latest node installer from the Node Downloads Page. It is best to use the latest release as that is what we generally test against.
+Run npm --version to verify.
The Wails CLI embeds a task runner called Task. It is optional, but recommended. If you do not wish to install Task, you can use the wails3 task command instead of task.
+Installing Task will give you the greatest flexibility.
You will also need to install platform specific dependencies:
+Wails requires that the xcode command line tools are installed. This can be +done by running:
+ +Wails requires that the WebView2 Runtime is installed. Some Windows installations will already have this installed. You can check using the wails doctor command.
Linux requires the standard gcc build tools plus libgtk3 and libwebkit. Rather than list a ton of commands for different distros, Wails can try to determine what the installation commands are for your specific distribution. Run wails doctor after installation to be shown how to install the dependencies. If your distro/package manager is not supported, please let us know on discord.
Running wails3 doctor will check if you have the correct dependencies
+installed. If not, it will advise on what is missing and help on how to rectify
+any problems.
wails3 command appears to be missing?If your system is reporting that the wails3 command is missing, check the
+following:
go/bin directory is in the PATH environment variable.PATH variable.Now that you have Wails installed, you can start exploring the alpha version.
+The best place to start is the examples directory in the Wails repository.
+This contains a number of examples that you can run and play with.
To run an example, you can simply use:
+ +in the example directory.
+The status of the examples is on the roadmap.
+To create a new project, you can use the wails3 init command. This will create
+a new project in the current directory.
Wails3 uses Task as its build system by default,
+although there is no reason why you can't use your own build system, or use
+go build directly. Wails has the task build system built in and can be run
+using wails3 task.
If you look through the Taskfile.yaml file, you will see that there are a
+number of tasks defined. The most important one is the build task. This is the
+task that is run when you use wails3 build.
The task file is unlikely to be complete and is subject to change over time.
+To build a project, you can use the wails3 build command. This is a shortcut
+for wails3 task build.
Warning
+| Operating System | +Status | +
|---|---|
| Windows | +All examples are working | +
| Mac | +Most examples are working | +
| Linux | +Some examples are working | +
The roadmap is a living document and is subject to change. If you have any +suggestions, please open an issue. Each milestone will have a set of goals that +we are aiming to achieve. These are subject to change.
+Alpha 1 is the initial release. It is intended to get feedback on the new API +and to get people experimenting with it. The main goal is to get most of the +examples working on all platforms.
+| + | Mac | +Windows | +Linux | +
|---|---|---|---|
| binding | ++ | + | + |
| build | ++ | + | + |
| clipboard | ++ | + | + |
| context menus | ++ | + | + |
| dialogs | ++ | + | + |
| drag-n-drop | ++ | + | + |
| events | ++ | + | + |
| frameless | ++ | + | + |
| keybindings | ++ | + | + |
| plain | ++ | + | + |
| screen | ++ | + | + |
| systray | ++ | + | + |
| video | ++ | + | + |
| window | ++ | + | + |
| wml | ++ | + | + |
+[CATransaction synchronize] called within transaction warnings on
+ Macwails initNote
+this list.
+It's now possible to create multiple windows and configure each one +independently.
+package main
+
+import (
+ _ "embed"
+ "log"
+
+ "github.com/wailsapp/wails/v3/pkg/application"
+)
+
+//go:embed assets/*
+var assets embed.FS
+
+func main() {
+
+ app := application.New(application.Options{
+ Name: "Multi Window Demo",
+ Assets: application.AssetOptions{
+ FS: assets,
+ },
+ })
+
+ window1 := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Title: "Window 1",
+ })
+
+ window2 := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Title: "Window 2",
+ })
+
+ // load the embedded html from the embed.FS
+ window1.SetURL("/")
+ window1.Center()
+
+ // Load an external URL
+ window2.SetURL("https://wails.app")
+
+ err := app.Run()
+
+ if err != nil {
+ log.Fatal(err.Error())
+ }
+}
+Systrays allow you to add an icon in the system tray area of your desktop and +have the following features:
+package main
+
+import (
+ _ "embed"
+ "log"
+ "runtime"
+
+ "github.com/wailsapp/wails/v3/pkg/application"
+ "github.com/wailsapp/wails/v3/pkg/icons"
+)
+
+func main() {
+ app := application.New(application.Options{
+ Name: "Systray Demo",
+ Mac: application.MacOptions{
+ ActivationPolicy: application.ActivationPolicyAccessory,
+ },
+ })
+
+ window := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Width: 500,
+ Height: 800,
+ Frameless: true,
+ AlwaysOnTop: true,
+ Hidden: true,
+ Windows: application.WindowsWindow{
+ HiddenOnTaskbar: true,
+ },
+ })
+
+ systemTray := app.NewSystemTray()
+
+ // Support for template icons on macOS
+ if runtime.GOOS == "darwin" {
+ systemTray.SetTemplateIcon(icons.SystrayMacTemplate)
+ } else {
+ // Support for light/dark mode icons
+ systemTray.SetDarkModeIcon(icons.SystrayDark)
+ systemTray.SetIcon(icons.SystrayLight)
+ }
+
+ // Support for menu
+ myMenu := app.NewMenu()
+ myMenu.Add("Hello World!").OnClick(func(_ *application.Context) {
+ println("Hello World!")
+ })
+ systemTray.SetMenu(myMenu)
+
+ // This will center the window to the systray icon with a 5px offset
+ // It will automatically be shown when the systray icon is clicked
+ // and hidden when the window loses focus
+ systemTray.AttachWindow(window).WindowOffset(5)
+
+ err := app.Run()
+ if err != nil {
+ log.Fatal(err)
+ }
+}
+Plugins allow you to extend the functionality of the Wails system. Not only can +plugin methods be used in Go, but also called from Javascript. Included plugins:
+v3 uses a new static analyser to generate bindings. This makes it extremely fast +and maintains comments and parameter names in your bindings. By default, +bindings are generated with calls using IDs instead of strings. This provides a +performance boost and allows for using obfuscation tools such as +garble.
+Bindings are generated by simply running wails3 generate bindings in the
+project directory.
// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+import { main } from "./models";
+
+window.go = window.go || {};
+window.go.main = {
+ GreetService: {
+ /**
+ * GreetService.Greet
+ * Greet greets a person
+ * @param name {string}
+ * @returns {Promise<string>}
+ **/
+ Greet: function (name) {
+ wails.CallByID(1411160069, ...Array.prototype.slice.call(arguments, 0));
+ },
+
+ /**
+ * GreetService.GreetPerson
+ * GreetPerson greets a person
+ * @param person {main.Person}
+ * @returns {Promise<string>}
+ **/
+ GreetPerson: function (person) {
+ wails.CallByID(4021313248, ...Array.prototype.slice.call(arguments, 0));
+ },
+ },
+};
+In v2, the build system was completely opaque and hard to customise. In v3, it's +possible to build everything using standard Go tooling.
+All the heavy lifting that the v2 build system did, such as icon generation, +have been added as tool commands in the CLI. We have incorporated +Taskfile into the CLI to orchestrate these calls to +bring the same developer experience as v2. However, this approach brings the +ultimate balance of flexibility and ease of use as you can now customise the +build process to your needs.
+You can even use make if that's your thing!
+build:darwin:
+ summary: Builds the application
+ platforms:
+ - darwin
+ cmds:
+ - task: pre-build
+ - task: build-frontend
+ - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}}
+ - task: post-build
+ env:
+ CGO_CFLAGS: "-mmacosx-version-min=10.13"
+ CGO_LDFLAGS: "-mmacosx-version-min=10.13"
+ MACOSX_DEPLOYMENT_TARGET: "10.13"
+Events are now emitted for a lot of the runtime operations, allowing you to hook +into application/system events. Cross-platform (common) events are also emitted +where there are common platform events, allowing you to write the same event +handling methods cross platform.
+Event hooks can also be registered. These are like the On method but are
+synchronous and allow you to cancel the event. An example of this would be to
+show a confirmation dialog before closing a window.
package main
+
+import (
+ _ "embed"
+ "log"
+ "time"
+
+ "github.com/wailsapp/wails/v3/pkg/application"
+ "github.com/wailsapp/wails/v3/pkg/events"
+)
+
+//go:embed assets
+var assets embed.FS
+
+func main() {
+
+ app := application.New(application.Options{
+ Name: "Events Demo",
+ Description: "A demo of the Events API",
+ Assets: application.AssetOptions{
+ FS: assets,
+ },
+ Mac: application.MacOptions{
+ ApplicationShouldTerminateAfterLastWindowClosed: true,
+ },
+ })
+
+ // Custom event handling
+ app.Events.On("myevent", func(e *application.WailsEvent) {
+ log.Printf("[Go] WailsEvent received: %+v\n", e)
+ })
+
+ // OS specific application events
+ app.On(events.Mac.ApplicationDidFinishLaunching, func(event *application.Event) {
+ println("events.Mac.ApplicationDidFinishLaunching fired!")
+ })
+
+ // Platform agnostic events
+ app.On(events.Common.ApplicationStarted, func(event *application.Event) {
+ println("events.Common.ApplicationStarted fired!")
+ })
+
+ win1 := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Title: "Takes 3 attempts to close me!",
+ })
+
+ var countdown = 3
+
+ // Register a hook to cancel the window closing
+ win1.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) {
+ countdown--
+ if countdown == 0 {
+ println("Closing!")
+ return
+ }
+ println("Nope! Not closing!")
+ e.Cancel()
+ })
+
+ win1.On(events.Common.WindowFocus, func(e *application.WindowEvent) {
+ println("[Event] Window focus!")
+ })
+
+ err := app.Run()
+
+ if err != nil {
+ log.Fatal(err.Error())
+ }
+}
+An experimental feature to call runtime methods using plain html, similar to +htmx.
+<!doctype html>
+<html lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <title>Wails ML Demo</title>
+ </head>
+ <body style="margin-top:50px; color: white; background-color: #191919">
+ <h2>Wails ML Demo</h2>
+ <p>This application contains no Javascript!</p>
+ <button wml-event="button-pressed">Press me!</button>
+ <button wml-event="delete-things" wml-confirm="Are you sure?">
+ Delete all the things!
+ </button>
+ <button wml-window="Close" wml-confirm="Are you sure?">
+ Close the Window?
+ </button>
+ <button wml-window="Center">Center</button>
+ <button wml-window="Minimise">Minimise</button>
+ <button wml-window="Maximise">Maximise</button>
+ <button wml-window="UnMaximise">UnMaximise</button>
+ <button wml-window="Fullscreen">Fullscreen</button>
+ <button wml-window="UnFullscreen">UnFullscreen</button>
+ <button wml-window="Restore">Restore</button>
+ <div
+ style="width: 200px; height: 200px; border: 2px solid white;"
+ wml-event="hover"
+ wml-trigger="mouseover"
+ >
+ Hover over me
+ </div>
+ </body>
+</html>
+应用程序 API 用于使用 Wails 框架创建应用程序。
+API：New(appOptions Options) *App
New(appOptions Options) 使用给定的应用程序选项创建一个新的应用程序。它对未指定
+的选项应用默认值，将其与提供的选项合并，然后初始化并返回应用程序的实例。
如果在初始化过程中出现错误，应用程序将停止，并显示提供的错误消息。
+需要注意的是，如果全局应用程序实例已经存在，将返回该实例，而不是创建新的实例。
+package main
+
+import "github.com/wailsapp/wails/v3/pkg/application"
+
+func main() {
+ app := application.New(application.Options{
+ Name: "WebviewWindow Demo",
+ // 其他选项
+ })
+
+ // 其余的应用程序逻辑
+}
+Get() 返回全局应用程序实例。在代码的不同部分需要访问应用程序时非常有用。
API：Capabilities() capabilities.Capabilities
Capabilities() 返回应用程序当前具有的功能的映射。这些功能可以是操作系统提供的
+不同功能，如 webview 功能。
// 获取应用程序的功能
+ capabilities := app.Capabilities()
+ if capabilities.HasNativeDrag {
+ // 做一些事情
+ }
+API：GetPID() int
GetPID() 返回应用程序的进程 ID。
API：Run() error
Run() 启动应用程序及其组件的执行。
app := application.New(application.Options{
+ // 选项
+ })
+ // 运行应用程序
+ err := application.Run()
+ if err != nil {
+ // 处理错误
+ }
+API：Quit()
Quit() 通过销毁窗口和可能的其他组件退出应用程序。
API：IsDarkMode() bool
IsDarkMode() 检查应用程序是否在暗模式下运行。它返回一个布尔值，指示是否启用了
+暗模式。
API：Hide()
Hide() 隐藏应用程序窗口。
API：Show()
Show() 显示应用程序窗口。
API：NewWebviewWindow() *WebviewWindow
NewWebviewWindow() 使用默认选项创建一个新的 Webview 窗口，并返回它。
API：NewWebviewWindowWithOptions(windowOptions WebviewWindowOptions) *WebviewWindow
NewWebviewWindowWithOptions() 使用自定义选项创建一个新的 Webview 窗口。新创建
+的窗口将添加到应用程序管理的窗口映射中。
// 使用自定义选项创建一个新的 Webview 窗口
+ window := app.NewWebviewWindowWithOptions(WebviewWindowOptions{
+ Name: "Main",
+ Title: "My Window",
+ Width: 800,
+ Height: 600,
+ })
+API：OnWindowCreation(callback func(window *WebviewWindow))
OnWindowCreation() 注册一个回调函数，当创建窗口时调用该函数。
API：GetWindowByName(name string) *WebviewWindow
GetWindowByName() 获取并返回具有特定名称的窗口。
API：CurrentWindow() *WebviewWindow
CurrentWindow() 获取并返回应用程序中当前活动窗口的指针。如果没有窗口，则返回
+nil。
API：RegisterContextMenu(name string, menu *Menu)
RegisterContextMenu() 注册具有给定名称的上下文菜单。稍后可以在应用程序中使用该
+菜单。
// 创建一个新的菜单
+ ctxmenu := app.NewMenu()
+
+ // 将菜单注册为上下文菜单
+ app.RegisterContextMenu("MyContextMenu", ctxmenu)
+API：SetMenu(menu *Menu)
SetMenu() 设置应用程序的菜单。在 Mac 上，这将是全局菜单。对于 Windows 和
+Linux，这将是任何新窗口的默认菜单。
API：ShowAboutDialog()
ShowAboutDialog() 显示一个 "关于" 对话框。可以显示应用程序的名称、描述和图标。
API：InfoDialog()
InfoDialog() 创建并返回一个具有 InfoDialogType 的 MessageDialog 的新实例。
+此对话框通常用于向用户显示信息消息。
API：QuestionDialog()
QuestionDialog() 创建并返回一个具有 QuestionDialogType 的 MessageDialog 的
+新实例。此对话框通常用于向用户提问并期望回应。
API：WarningDialog()
WarningDialog() 创建并返回一个具有 WarningDialogType 的 MessageDialog 的新
+实例。如其名称所示，此对话框主要用于向用户显示警告消息。
API：ErrorDialog()
ErrorDialog() 创建并返回一个具有 ErrorDialogType 的 MessageDialog 的新实
+例。此对话框设计用于在需要向用户显示错误消息时使用。
API：OpenFileDialog()
OpenFileDialog() 创建并返回一个新的 OpenFileDialogStruct。此对话框提示用户从
+其文件系统中选择一个或多个文件。
API：SaveFileDialog()
SaveFileDialog() 创建并返回一个新的 SaveFileDialogStruct。此对话框提示用户选
+择其文件系统上的位置以保存文件。
API：OpenDirectoryDialog()
OpenDirectoryDialog() 创建并返回一个具有 OpenDirectoryDialogType 的
+MessageDialog 的新实例。此对话框使用户能够从其文件系统中选择目录。
API：On(eventType events.ApplicationEventType, callback func(event *Event)) func()
On() 注册特定应用程序事件的事件侦听器。提供的回调函数将在相应事件发生时触发。
+该函数返回一个可调用的函数，用于删除侦听器。
API：RegisterHook(eventType events.ApplicationEventType, callback func(event *Event)) func()
RegisterHook() 注册要在特定事件期间作为钩子运行的回调函数。这些钩子在使用
+On() 附加的侦听器之前运行。该函数返回一个可调用的函数，用于删除钩子。
API：GetPrimaryScreen() (*Screen, error)
GetPrimaryScreen() 返回系统的主屏幕。
API：GetScreens() ([]*Screen, error)
GetScreens() 返回有关连接到系统的所有屏幕的信息。
这是提供的 App 结构中导出的方法的简要摘要。请注意，有关更详细的功能或注意事
+项，请参考实际的 Go 代码或进一步的内部文档。
package application
+
+import (
+ "io/fs"
+ "log/slog"
+ "net/http"
+)
+
+type Options struct {
+ // Name is the name of the application
+ Name string
+
+ // Description is the description of the application (used in the default about box)
+ Description string
+
+ // Icon is the icon of the application (used in the default about box)
+ Icon []byte
+
+ // Mac is the Mac specific configuration for Mac builds
+ Mac MacOptions
+
+ // Windows is the Windows specific configuration for Windows builds
+ Windows WindowsOptions
+
+ // Bind allows you to bind Go methods to the frontend.
+ Bind []any
+
+ // BindAliases allows you to specify alias IDs for your bound methods.
+ // Example: `BindAliases: map[uint32]uint32{1: 1411160069}` states that alias ID 1 maps to the Go method with ID 1411160069.
+ BindAliases map[uint32]uint32
+
+ // Logger i a slog.Logger instance used for logging Wails system messages (not application messages).
+ // If not defined, a default logger is used.
+ Logger *slog.Logger
+
+ // LogLevel defines the log level of the Wails system logger.
+ LogLevel slog.Level
+
+ // Assets are the application assets to be used.
+ Assets AssetOptions
+
+ // Plugins is a map of plugins used by the application
+ Plugins map[string]Plugin
+
+ // Flags are key value pairs that are available to the frontend.
+ // This is also used by Wails to provide information to the frontend.
+ Flags map[string]any
+
+ // PanicHandler is a way to register a custom panic handler
+ PanicHandler func(any)
+
+ // KeyBindings is a map of key bindings to functions
+ KeyBindings map[string]func(window *WebviewWindow)
+}
+
+// AssetOptions defines the configuration of the AssetServer.
+type AssetOptions struct {
+ // FS defines the static assets to be used. A GET request is first tried to be served from this FS. If the FS returns
+ // `os.ErrNotExist` for that file, the request handling will fallback to the Handler and tries to serve the GET
+ // request from it.
+ //
+ // If set to nil, all GET requests will be forwarded to Handler.
+ FS fs.FS
+
+ // Handler will be called for every GET request that can't be served from FS, due to `os.ErrNotExist`. Furthermore all
+ // non GET requests will always be served from this Handler.
+ //
+ // If not defined, the result is the following in cases where the Handler would have been called:
+ // GET request: `http.StatusNotFound`
+ // Other request: `http.StatusMethodNotAllowed`
+ Handler http.Handler
+
+ // Middleware is HTTP Middleware which allows to hook into the AssetServer request chain. It allows to skip the default
+ // request handler dynamically, e.g. implement specialized Routing etc.
+ // The Middleware is called to build a new `http.Handler` used by the AssetSever and it also receives the default
+ // handler used by the AssetServer as an argument.
+ //
+ // If not defined, the default AssetServer request chain is executed.
+ //
+ // Multiple Middlewares can be chained together with:
+ // ChainMiddleware(middleware ...Middleware) Middleware
+ Middleware Middleware
+
+ // External URL can be set to a development server URL so that all requests are forwarded to it. This is useful
+ // when using a development server like `vite` or `snowpack` which serves the assets on a different port.
+ ExternalURL string
+}
+
+// Middleware defines HTTP middleware that can be applied to the AssetServer.
+// The handler passed as next is the next handler in the chain. One can decide to call the next handler
+// or implement a specialized handling.
+type Middleware func(next http.Handler) http.Handler
+
+// ChainMiddleware allows chaining multiple middlewares to one middleware.
+func ChainMiddleware(middleware ...Middleware) Middleware {
+ return func(h http.Handler) http.Handler {
+ for i := len(middleware) - 1; i >= 0; i-- {
+ h = middleware[i](h)
+ }
+ return h
+ }
+}
+package application
+
+// WindowsOptions contains options for Windows applications.
+type WindowsOptions struct {
+
+ // WndProcInterceptor is a function that will be called for every message sent in the application.
+ // Use this to hook into the main message loop. This is useful for handling custom window messages.
+ // If `shouldReturn` is `true` then `returnCode` will be returned by the main message loop.
+ // If `shouldReturn` is `false` then returnCode will be ignored and the message will be processed by the main message loop.
+ WndProcInterceptor func(hwnd uintptr, msg uint32, wParam, lParam uintptr) (returnCode uintptr, shouldReturn bool)
+
+ // DisableQuitOnLastWindowClosed disables the auto quit of the application if the last window has been closed.
+ DisableQuitOnLastWindowClosed bool
+
+ // Path where the WebView2 stores the user data. If empty %APPDATA%\[BinaryName.exe] will be used.
+ // If the path is not valid, a messagebox will be displayed with the error and the app will exit with error code.
+ WebviewUserDataPath string
+
+ // Path to the directory with WebView2 executables. If empty WebView2 installed in the system will be used.
+ WebviewBrowserPath string
+}
+package application
+
+// ActivationPolicy is the activation policy for the application.
+type ActivationPolicy int
+
+const (
+ // ActivationPolicyRegular is used for applications that have a user interface,
+ ActivationPolicyRegular ActivationPolicy = iota
+ // ActivationPolicyAccessory is used for applications that do not have a main window,
+ // such as system tray applications or background applications.
+ ActivationPolicyAccessory
+ ActivationPolicyProhibited
+)
+
+// MacOptions contains options for macOS applications.
+type MacOptions struct {
+ // ActivationPolicy is the activation policy for the application. Defaults to
+ // applicationActivationPolicyRegular.
+ ActivationPolicy ActivationPolicy
+ // If set to true, the application will terminate when the last window is closed.
+ ApplicationShouldTerminateAfterLastWindowClosed bool
+}
+const (
+ DialogInfo = 0
+ DialogWarning = 1
+ DialogError = 2
+ DialogQuestion = 3
+ DialogOpenFile = 4
+ DialogSaveFile = 5
+)
+const (
+ WindowCenter = 0
+ WindowSetTitle = 1
+ WindowFullscreen = 2
+ WindowUnFullscreen = 3
+ WindowSetSize = 4
+ WindowSize = 5
+ WindowSetMaxSize = 6
+ WindowSetMinSize = 7
+ WindowSetAlwaysOnTop = 8
+ WindowSetRelativePosition = 9
+ WindowRelativePosition = 10
+ WindowScreen = 11
+ WindowHide = 12
+ WindowMaximise = 13
+ WindowUnMaximise = 14
+ WindowToggleMaximise = 15
+ WindowMinimise = 16
+ WindowUnMinimise = 17
+ WindowRestore = 18
+ WindowShow = 19
+ WindowClose = 20
+ WindowSetBackgroundColour = 21
+ WindowSetResizable = 22
+ WindowWidth = 23
+ WindowHeight = 24
+ WindowZoomIn = 25
+ WindowZoomOut = 26
+ WindowZoomReset = 27
+ WindowGetZoomLevel = 28
+ WindowSetZoomLevel = 29
+)
+const (
+ NSImageNone = iota
+ NSImageOnly
+ NSImageLeft
+ NSImageRight
+ NSImageBelow
+ NSImageAbove
+ NSImageOverlaps
+ NSImageLeading
+ NSImageTrailing
+)
+BuildInfo contains the build info for the application
+ +BuildSettings contains the build settings for the +application
+ +MacTitleBarDefault results in the default Mac +MacTitleBar
+var MacTitleBarDefault = MacTitleBar{
+ AppearsTransparent: false,
+ Hide: false,
+ HideTitle: false,
+ FullSizeContent: false,
+ UseToolbar: false,
+ HideToolbarSeparator: false,
+}
+MacTitleBarHidden results in a hidden title bar +and a full size content window, yet the title bar still has the standard window +controls (“traffic lights”) in the top left.
+var MacTitleBarHidden = MacTitleBar{
+ AppearsTransparent: true,
+ Hide: false,
+ HideTitle: true,
+ FullSizeContent: true,
+ UseToolbar: false,
+ HideToolbarSeparator: false,
+}
+MacTitleBarHiddenInset results in a hidden +title bar with an alternative look where the traffic light buttons are slightly +more inset from the window edge.
+var MacTitleBarHiddenInset = MacTitleBar{
+ AppearsTransparent: true,
+ Hide: false,
+ HideTitle: true,
+ FullSizeContent: true,
+ UseToolbar: true,
+ HideToolbarSeparator: true,
+}
+MacTitleBarHiddenInsetUnified +results in a hidden title bar with an alternative look where the traffic light +buttons are even more inset from the window edge.
+var MacTitleBarHiddenInsetUnified = MacTitleBar{
+ AppearsTransparent: true,
+ Hide: false,
+ HideTitle: true,
+ FullSizeContent: true,
+ UseToolbar: true,
+ HideToolbarSeparator: true,
+ ToolbarStyle: MacToolbarStyleUnified,
+}
+var VirtualKeyCodes = map[uint]string{
+ 0x01: "lbutton",
+ 0x02: "rbutton",
+ 0x03: "cancel",
+ 0x04: "mbutton",
+ 0x05: "xbutton1",
+ 0x06: "xbutton2",
+ 0x08: "back",
+ 0x09: "tab",
+ 0x0C: "clear",
+ 0x0D: "return",
+ 0x10: "shift",
+ 0x11: "control",
+ 0x12: "menu",
+ 0x13: "pause",
+ 0x14: "capital",
+ 0x15: "kana",
+ 0x17: "junja",
+ 0x18: "final",
+ 0x19: "hanja",
+ 0x1B: "escape",
+ 0x1C: "convert",
+ 0x1D: "nonconvert",
+ 0x1E: "accept",
+ 0x1F: "modechange",
+ 0x20: "space",
+ 0x21: "prior",
+ 0x22: "next",
+ 0x23: "end",
+ 0x24: "home",
+ 0x25: "left",
+ 0x26: "up",
+ 0x27: "right",
+ 0x28: "down",
+ 0x29: "select",
+ 0x2A: "print",
+ 0x2B: "execute",
+ 0x2C: "snapshot",
+ 0x2D: "insert",
+ 0x2E: "delete",
+ 0x2F: "help",
+ 0x30: "0",
+ 0x31: "1",
+ 0x32: "2",
+ 0x33: "3",
+ 0x34: "4",
+ 0x35: "5",
+ 0x36: "6",
+ 0x37: "7",
+ 0x38: "8",
+ 0x39: "9",
+ 0x41: "a",
+ 0x42: "b",
+ 0x43: "c",
+ 0x44: "d",
+ 0x45: "e",
+ 0x46: "f",
+ 0x47: "g",
+ 0x48: "h",
+ 0x49: "i",
+ 0x4A: "j",
+ 0x4B: "k",
+ 0x4C: "l",
+ 0x4D: "m",
+ 0x4E: "n",
+ 0x4F: "o",
+ 0x50: "p",
+ 0x51: "q",
+ 0x52: "r",
+ 0x53: "s",
+ 0x54: "t",
+ 0x55: "u",
+ 0x56: "v",
+ 0x57: "w",
+ 0x58: "x",
+ 0x59: "y",
+ 0x5A: "z",
+ 0x5B: "lwin",
+ 0x5C: "rwin",
+ 0x5D: "apps",
+ 0x5F: "sleep",
+ 0x60: "numpad0",
+ 0x61: "numpad1",
+ 0x62: "numpad2",
+ 0x63: "numpad3",
+ 0x64: "numpad4",
+ 0x65: "numpad5",
+ 0x66: "numpad6",
+ 0x67: "numpad7",
+ 0x68: "numpad8",
+ 0x69: "numpad9",
+ 0x6A: "multiply",
+ 0x6B: "add",
+ 0x6C: "separator",
+ 0x6D: "subtract",
+ 0x6E: "decimal",
+ 0x6F: "divide",
+ 0x70: "f1",
+ 0x71: "f2",
+ 0x72: "f3",
+ 0x73: "f4",
+ 0x74: "f5",
+ 0x75: "f6",
+ 0x76: "f7",
+ 0x77: "f8",
+ 0x78: "f9",
+ 0x79: "f10",
+ 0x7A: "f11",
+ 0x7B: "f12",
+ 0x7C: "f13",
+ 0x7D: "f14",
+ 0x7E: "f15",
+ 0x7F: "f16",
+ 0x80: "f17",
+ 0x81: "f18",
+ 0x82: "f19",
+ 0x83: "f20",
+ 0x84: "f21",
+ 0x85: "f22",
+ 0x86: "f23",
+ 0x87: "f24",
+ 0x88: "navigation_view",
+ 0x89: "navigation_menu",
+ 0x8A: "navigation_up",
+ 0x8B: "navigation_down",
+ 0x8C: "navigation_left",
+ 0x8D: "navigation_right",
+ 0x8E: "navigation_accept",
+ 0x8F: "navigation_cancel",
+ 0x90: "numlock",
+ 0x91: "scroll",
+ 0x92: "oem_nec_equal",
+ 0x93: "oem_fj_masshou",
+ 0x94: "oem_fj_touroku",
+ 0x95: "oem_fj_loya",
+ 0x96: "oem_fj_roya",
+ 0xA0: "lshift",
+ 0xA1: "rshift",
+ 0xA2: "lcontrol",
+ 0xA3: "rcontrol",
+ 0xA4: "lmenu",
+ 0xA5: "rmenu",
+ 0xA6: "browser_back",
+ 0xA7: "browser_forward",
+ 0xA8: "browser_refresh",
+ 0xA9: "browser_stop",
+ 0xAA: "browser_search",
+ 0xAB: "browser_favorites",
+ 0xAC: "browser_home",
+ 0xAD: "volume_mute",
+ 0xAE: "volume_down",
+ 0xAF: "volume_up",
+ 0xB0: "media_next_track",
+ 0xB1: "media_prev_track",
+ 0xB2: "media_stop",
+ 0xB3: "media_play_pause",
+ 0xB4: "launch_mail",
+ 0xB5: "launch_media_select",
+ 0xB6: "launch_app1",
+ 0xB7: "launch_app2",
+ 0xBA: "oem_1",
+ 0xBB: "oem_plus",
+ 0xBC: "oem_comma",
+ 0xBD: "oem_minus",
+ 0xBE: "oem_period",
+ 0xBF: "oem_2",
+ 0xC0: "oem_3",
+ 0xC3: "gamepad_a",
+ 0xC4: "gamepad_b",
+ 0xC5: "gamepad_x",
+ 0xC6: "gamepad_y",
+ 0xC7: "gamepad_right_shoulder",
+ 0xC8: "gamepad_left_shoulder",
+ 0xC9: "gamepad_left_trigger",
+ 0xCA: "gamepad_right_trigger",
+ 0xCB: "gamepad_dpad_up",
+ 0xCC: "gamepad_dpad_down",
+ 0xCD: "gamepad_dpad_left",
+ 0xCE: "gamepad_dpad_right",
+ 0xCF: "gamepad_menu",
+ 0xD0: "gamepad_view",
+ 0xD1: "gamepad_left_thumbstick_button",
+ 0xD2: "gamepad_right_thumbstick_button",
+ 0xD3: "gamepad_left_thumbstick_up",
+ 0xD4: "gamepad_left_thumbstick_down",
+ 0xD5: "gamepad_left_thumbstick_right",
+ 0xD6: "gamepad_left_thumbstick_left",
+ 0xD7: "gamepad_right_thumbstick_up",
+ 0xD8: "gamepad_right_thumbstick_down",
+ 0xD9: "gamepad_right_thumbstick_right",
+ 0xDA: "gamepad_right_thumbstick_left",
+ 0xDB: "oem_4",
+ 0xDC: "oem_5",
+ 0xDD: "oem_6",
+ 0xDE: "oem_7",
+ 0xDF: "oem_8",
+ 0xE1: "oem_ax",
+ 0xE2: "oem_102",
+ 0xE3: "ico_help",
+ 0xE4: "ico_00",
+ 0xE5: "processkey",
+ 0xE6: "ico_clear",
+ 0xE7: "packet",
+ 0xE9: "oem_reset",
+ 0xEA: "oem_jump",
+ 0xEB: "oem_pa1",
+ 0xEC: "oem_pa2",
+ 0xED: "oem_pa3",
+ 0xEE: "oem_wsctrl",
+ 0xEF: "oem_cusel",
+ 0xF0: "oem_attn",
+ 0xF1: "oem_finish",
+ 0xF2: "oem_copy",
+ 0xF3: "oem_auto",
+ 0xF4: "oem_enlw",
+ 0xF5: "oem_backtab",
+ 0xF6: "attn",
+ 0xF7: "crsel",
+ 0xF8: "exsel",
+ 0xF9: "ereof",
+ 0xFA: "play",
+ 0xFB: "zoom",
+ 0xFC: "noname",
+ 0xFD: "pa1",
+ 0xFE: "oem_clear",
+}
+var WebviewWindowDefaults = &WebviewWindowOptions{
+ Title: "",
+ Width: 800,
+ Height: 600,
+ URL: "",
+ BackgroundColour: RGBA{
+ Red: 255,
+ Green: 255,
+ Blue: 255,
+ Alpha: 255,
+ },
+}
+ActivationPolicy is the activation policy for the application.
+ + +const (
+ // ActivationPolicyRegular is used for applications that have a user interface,
+ ActivationPolicyRegular ActivationPolicy = iota
+ // ActivationPolicyAccessory is used for applications that do not have a main window,
+ // such as system tray applications or background applications.
+ ActivationPolicyAccessory
+ ActivationPolicyProhibited
+)
+type App struct {
+
+ // The main application menu
+ ApplicationMenu *Menu
+
+ Events *EventProcessor
+ Logger *slog.Logger
+ // contains filtered or unexported fields
+}
+func (a *App) RegisterHook(eventType events.ApplicationEventType, callback func(event *Event)) func()
+RegisterHook registers a hook for the given event type. Hooks are called before +the event listeners and can cancel the event. The returned function can be +called to remove the hook.
+ +AssetOptions defines the configuration of the AssetServer.
+type AssetOptions struct {
+ // FS defines the static assets to be used. A GET request is first tried to be served from this FS. If the FS returns
+ // `os.ErrNotExist` for that file, the request handling will fallback to the Handler and tries to serve the GET
+ // request from it.
+ //
+ // If set to nil, all GET requests will be forwarded to Handler.
+ FS fs.FS
+
+ // Handler will be called for every GET request that can't be served from FS, due to `os.ErrNotExist`. Furthermore all
+ // non GET requests will always be served from this Handler.
+ //
+ // If not defined, the result is the following in cases where the Handler would have been called:
+ // GET request: `http.StatusNotFound`
+ // Other request: `http.StatusMethodNotAllowed`
+ Handler http.Handler
+
+ // Middleware is HTTP Middleware which allows to hook into the AssetServer request chain. It allows to skip the default
+ // request handler dynamically, e.g. implement specialized Routing etc.
+ // The Middleware is called to build a new `http.Handler` used by the AssetSever and it also receives the default
+ // handler used by the AssetServer as an argument.
+ //
+ // If not defined, the default AssetServer request chain is executed.
+ //
+ // Multiple Middlewares can be chained together with:
+ // ChainMiddleware(middleware ...Middleware) Middleware
+ Middleware Middleware
+
+ // External URL can be set to a development server URL so that all requests are forwarded to it. This is useful
+ // when using a development server like `vite` or `snowpack` which serves the assets on a different port.
+ ExternalURL string
+}
+const (
+ Auto BackdropType = 0
+ None BackdropType = 1
+ Mica BackdropType = 2
+ Acrylic BackdropType = 3
+ Tabbed BackdropType = 4
+)
+const (
+ BackgroundTypeSolid BackgroundType = iota
+ BackgroundTypeTransparent
+ BackgroundTypeTranslucent
+)
+Add the given struct methods to the Bindings
+ +GenerateID generates a unique ID for a binding
+ +Get returns the bound method with the given name
+ +GetByID returns the bound method with the given ID
+ +BoundMethod defines all the data related to a Go method that is bound to the +Wails application
+type BoundMethod struct {
+ ID uint32 `json:"id"`
+ Name string `json:"name"`
+ Inputs []*Parameter `json:"inputs,omitempty"`
+ Outputs []*Parameter `json:"outputs,omitempty"`
+ Comments string `json:"comments,omitempty"`
+ Method reflect.Value `json:"-"`
+ PackageName string
+ StructName string
+ PackagePath string
+}
+Call will attempt to call this bound method with the given args
+ +type CallOptions struct {
+ MethodID uint32 `json:"methodID"`
+ PackageName string `json:"packageName"`
+ StructName string `json:"structName"`
+ MethodName string `json:"methodName"`
+ Args []any `json:"args"`
+}
+type ContextMenuData struct {
+ Id string `json:"id"`
+ X int `json:"x"`
+ Y int `json:"y"`
+ Data any `json:"data"`
+}
+const (
+ InfoDialogType DialogType = iota
+ QuestionDialogType
+ WarningDialogType
+ ErrorDialogType
+ OpenDirectoryDialogType
+)
+EventProcessor handles custom events
+ + +Emit sends an event to all listeners
+ +On is the equivalent of Javascript's `addEventListener`
+ +func (e *EventProcessor) OnMultiple(eventName string, callback func(event *WailsEvent), counter int) func()
+OnMultiple is the same as `On` but will unregister after `count` events
+ +Once is the same as `On` but will unregister after the first event
+ +RegisterHook provides a means of registering methods to be called before +emitting the event
+ +type FileFilter struct {
+ DisplayName string // Filter information EG: "Image Files (*.jpg, *.png)"
+ Pattern string // semicolon separated list of extensions, EG: "*.jpg;*.png"
+}
+MacAppearanceType is a type of Appearance for Cocoa windows
+ + +const (
+ // DefaultAppearance uses the default system value
+ DefaultAppearance MacAppearanceType = ""
+ // NSAppearanceNameAqua - The standard light system appearance.
+ NSAppearanceNameAqua MacAppearanceType = "NSAppearanceNameAqua"
+ // NSAppearanceNameDarkAqua - The standard dark system appearance.
+ NSAppearanceNameDarkAqua MacAppearanceType = "NSAppearanceNameDarkAqua"
+ // NSAppearanceNameVibrantLight - The light vibrant appearance
+ NSAppearanceNameVibrantLight MacAppearanceType = "NSAppearanceNameVibrantLight"
+ // NSAppearanceNameAccessibilityHighContrastAqua - A high-contrast version of the standard light system appearance.
+ NSAppearanceNameAccessibilityHighContrastAqua MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastAqua"
+ // NSAppearanceNameAccessibilityHighContrastDarkAqua - A high-contrast version of the standard dark system appearance.
+ NSAppearanceNameAccessibilityHighContrastDarkAqua MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastDarkAqua"
+ // NSAppearanceNameAccessibilityHighContrastVibrantLight - A high-contrast version of the light vibrant appearance.
+ NSAppearanceNameAccessibilityHighContrastVibrantLight MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastVibrantLight"
+ // NSAppearanceNameAccessibilityHighContrastVibrantDark - A high-contrast version of the dark vibrant appearance.
+ NSAppearanceNameAccessibilityHighContrastVibrantDark MacAppearanceType = "NSAppearanceNameAccessibilityHighContrastVibrantDark"
+)
+MacBackdrop is the backdrop type for macOS
+ + +const (
+ // MacBackdropNormal - The default value. The window will have a normal opaque background.
+ MacBackdropNormal MacBackdrop = iota
+ // MacBackdropTransparent - The window will have a transparent background, with the content underneath it being visible
+ MacBackdropTransparent
+ // MacBackdropTranslucent - The window will have a translucent background, with the content underneath it being "fuzzy" or "frosted"
+ MacBackdropTranslucent
+)
+MacOptions contains options for macOS applications.
+type MacOptions struct {
+ // ActivationPolicy is the activation policy for the application. Defaults to
+ // applicationActivationPolicyRegular.
+ ActivationPolicy ActivationPolicy
+ // If set to true, the application will terminate when the last window is closed.
+ ApplicationShouldTerminateAfterLastWindowClosed bool
+}
+MacTitleBar contains options for the Mac titlebar
+type MacTitleBar struct {
+ // AppearsTransparent will make the titlebar transparent
+ AppearsTransparent bool
+ // Hide will hide the titlebar
+ Hide bool
+ // HideTitle will hide the title
+ HideTitle bool
+ // FullSizeContent will extend the window content to the full size of the window
+ FullSizeContent bool
+ // UseToolbar will use a toolbar instead of a titlebar
+ UseToolbar bool
+ // HideToolbarSeparator will hide the toolbar separator
+ HideToolbarSeparator bool
+ // ToolbarStyle is the style of toolbar to use
+ ToolbarStyle MacToolbarStyle
+}
+MacToolbarStyle is the style of toolbar for macOS
+ + +const (
+ // MacToolbarStyleAutomatic - The default value. The style will be determined by the window's given configuration
+ MacToolbarStyleAutomatic MacToolbarStyle = iota
+ // MacToolbarStyleExpanded - The toolbar will appear below the window title
+ MacToolbarStyleExpanded
+ // MacToolbarStylePreference - The toolbar will appear below the window title and the items in the toolbar will attempt to have equal widths when possible
+ MacToolbarStylePreference
+ // MacToolbarStyleUnified - The window title will appear inline with the toolbar when visible
+ MacToolbarStyleUnified
+ // MacToolbarStyleUnifiedCompact - Same as MacToolbarStyleUnified, but with reduced margins in the toolbar allowing more focus to be on the contents of the window
+ MacToolbarStyleUnifiedCompact
+)
+MacWindow contains macOS specific options for Webview Windows
+type MacWindow struct {
+ // Backdrop is the backdrop type for the window
+ Backdrop MacBackdrop
+ // DisableShadow will disable the window shadow
+ DisableShadow bool
+ // TitleBar contains options for the Mac titlebar
+ TitleBar MacTitleBar
+ // Appearance is the appearance type for the window
+ Appearance MacAppearanceType
+ // InvisibleTitleBarHeight defines the height of an invisible titlebar which responds to dragging
+ InvisibleTitleBarHeight int
+ // Maps events from platform specific to common event types
+ EventMapping map[events.WindowEventType]events.WindowEventType
+
+ // EnableFraudulentWebsiteWarnings will enable warnings for fraudulent websites.
+ // Default: false
+ EnableFraudulentWebsiteWarnings bool
+}
+type MessageDialogOptions struct {
+ DialogType DialogType
+ Title string
+ Message string
+ Buttons []*Button
+ Icon []byte
+ // contains filtered or unexported fields
+}
+Middleware defines HTTP middleware that can be applied to the AssetServer. The +handler passed as next is the next handler in the chain. One can decide to call +the next handler or implement a specialized handling.
+ + +ChainMiddleware allows chaining multiple middlewares to one middleware.
+ +type OpenFileDialogOptions struct {
+ CanChooseDirectories bool
+ CanChooseFiles bool
+ CanCreateDirectories bool
+ ShowHiddenFiles bool
+ ResolvesAliases bool
+ AllowsMultipleSelection bool
+ HideExtension bool
+ CanSelectHiddenExtension bool
+ TreatsFilePackagesAsDirectories bool
+ AllowsOtherFileTypes bool
+ Filters []FileFilter
+ Window *WebviewWindow
+
+ Title string
+ Message string
+ ButtonText string
+ Directory string
+}
+AddFilter adds a filter to the dialog. The filter is a display name and a +semicolon separated list of extensions. EG: AddFilter("Image Files", +"*.jpg;*.png")
+ +func (d *OpenFileDialogStruct) AllowsOtherFileTypes(allowsOtherFileTypes bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) CanChooseDirectories(canChooseDirectories bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) CanCreateDirectories(canCreateDirectories bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) CanSelectHiddenExtension(canSelectHiddenExtension bool) *OpenFileDialogStruct
+func (d *OpenFileDialogStruct) TreatsFilePackagesAsDirectories(treatsFilePackagesAsDirectories bool) *OpenFileDialogStruct
+type Options struct {
+ // Name is the name of the application
+ Name string
+
+ // Description is the description of the application (used in the default about box)
+ Description string
+
+ // Icon is the icon of the application (used in the default about box)
+ Icon []byte
+
+ // Mac is the Mac specific configuration for Mac builds
+ Mac MacOptions
+
+ // Windows is the Windows specific configuration for Windows builds
+ Windows WindowsOptions
+
+ // Bind allows you to bind Go methods to the frontend.
+ Bind []any
+
+ // BindAliases allows you to specify alias IDs for your bound methods.
+ // Example: `BindAliases: map[uint32]uint32{1: 1411160069}` states that alias ID 1 maps to the Go method with ID 1411160069.
+ BindAliases map[uint32]uint32
+
+ // Logger i a slog.Logger instance used for logging Wails system messages (not application messages).
+ // If not defined, a default logger is used.
+ Logger *slog.Logger
+
+ // LogLevel defines the log level of the Wails system logger.
+ LogLevel slog.Level
+
+ // Assets are the application assets to be used.
+ Assets AssetOptions
+
+ // Plugins is a map of plugins used by the application
+ Plugins map[string]Plugin
+
+ // Flags are key value pairs that are available to the frontend.
+ // This is also used by Wails to provide information to the frontend.
+ Flags map[string]any
+
+ // PanicHandler is a way to register a custom panic handler
+ PanicHandler func(any)
+
+ // KeyBindings is a map of key bindings to functions
+ KeyBindings map[string]func(window *WebviewWindow)
+}
+Parameter defines a Go method parameter
+type Parameter struct {
+ Name string `json:"name,omitempty"`
+ TypeName string `json:"type"`
+ ReflectType reflect.Type
+}
+IsError returns true if the parameter type is an error
+ +IsType returns true if the given
+ +type Plugin interface {
+ Name() string
+ Init() error
+ Shutdown()
+ CallableByJS() []string
+ InjectJS() string
+}
+func NewPluginManager(plugins map[string]Plugin, assetServer *assetserver.AssetServer) *PluginManager
+Role is a type to identify menu roles
+ +These constants need to be kept in sync with +`v2/internal/frontend/desktop/darwin/Role.h`
+const (
+ NoRole Role = iota
+ AppMenu Role = iota
+ EditMenu Role = iota
+ ViewMenu Role = iota
+ WindowMenu Role = iota
+ ServicesMenu Role = iota
+ HelpMenu Role = iota
+
+ Hide Role = iota
+ HideOthers Role = iota
+ UnHide Role = iota
+ About Role = iota
+ Undo Role = iota
+ Redo Role = iota
+ Cut Role = iota
+ Copy Role = iota
+ Paste Role = iota
+ PasteAndMatchStyle Role = iota
+ SelectAll Role = iota
+ Delete Role = iota
+ SpeechMenu Role = iota
+ Quit Role = iota
+ FileMenu Role = iota
+ Close Role = iota
+ Reload Role = iota
+ ForceReload Role = iota
+ ToggleDevTools Role = iota
+ ResetZoom Role = iota
+ ZoomIn Role = iota
+ ZoomOut Role = iota
+ ToggleFullscreen Role = iota
+
+ Minimize Role = iota
+ Zoom Role = iota
+ FullScreen Role = iota
+)
+type SaveFileDialogOptions struct {
+ CanCreateDirectories bool
+ ShowHiddenFiles bool
+ CanSelectHiddenExtension bool
+ AllowOtherFileTypes bool
+ HideExtension bool
+ TreatsFilePackagesAsDirectories bool
+ Title string
+ Message string
+ Directory string
+ Filename string
+ ButtonText string
+ Filters []FileFilter
+ Window *WebviewWindow
+}
+AddFilter adds a filter to the dialog. The filter is a display name and a +semicolon separated list of extensions. EG: AddFilter("Image Files", +"*.jpg;*.png")
+ +func (d *SaveFileDialogStruct) AllowsOtherFileTypes(allowOtherFileTypes bool) *SaveFileDialogStruct
+func (d *SaveFileDialogStruct) CanCreateDirectories(canCreateDirectories bool) *SaveFileDialogStruct
+func (d *SaveFileDialogStruct) CanSelectHiddenExtension(canSelectHiddenExtension bool) *SaveFileDialogStruct
+func (d *SaveFileDialogStruct) TreatsFilePackagesAsDirectories(treatsFilePackagesAsDirectories bool) *SaveFileDialogStruct
+type Screen struct {
+ ID string // A unique identifier for the display
+ Name string // The name of the display
+ Scale float32 // The scale factor of the display
+ X int // The x-coordinate of the top-left corner of the rectangle
+ Y int // The y-coordinate of the top-left corner of the rectangle
+ Size Size // The size of the display
+ Bounds Rect // The bounds of the display
+ WorkArea Rect // The work area of the display
+ IsPrimary bool // Whether this is the primary display
+ Rotation float32 // The rotation of the display
+}
+AttachWindow attaches a window to the system tray. The window will be shown when +the system tray icon is clicked. The window will be hidden when the system tray +icon is clicked again, or when the window loses focus.
+ +WindowDebounce is used by Windows to indicate how long to wait before responding +to a mouse up event on the notification icon. This prevents the window from +being hidden and then immediately shown when the user clicks on the system tray +icon. See +https://stackoverflow.com/questions/4585283/alternate-showing-hiding-window-when-notify-icon-is-clicked
+ +WindowOffset sets the gap in pixels between the system tray and the window
+ +const (
+ // SystemDefault will use whatever the system theme is. The application will follow system theme changes.
+ SystemDefault Theme = 0
+ // Dark Mode
+ Dark Theme = 1
+ // Light Mode
+ Light Theme = 2
+)
+ThemeSettings defines custom colours to use in dark or light mode. They may be +set using the hex values: 0x00BBGGRR
+type ThemeSettings struct {
+ DarkModeTitleBar int32
+ DarkModeTitleBarInactive int32
+ DarkModeTitleText int32
+ DarkModeTitleTextInactive int32
+ DarkModeBorder int32
+ DarkModeBorderInactive int32
+ LightModeTitleBar int32
+ LightModeTitleBarInactive int32
+ LightModeTitleText int32
+ LightModeTitleTextInactive int32
+ LightModeBorder int32
+ LightModeBorderInactive int32
+}
+type WailsEvent struct {
+ Name string `json:"name"`
+ Data any `json:"data"`
+ Sender string `json:"sender"`
+ Cancelled bool
+}
+AbsolutePosition returns the absolute position of the window to the screen
+ +Center centers the window on the screen
+ +Close closes the window
+ +ExecJS executes the given javascript in the context of the window.
+ +Flash flashes the window's taskbar button/icon. Windows only.
+ +ForceReload forces the window to reload the page assets
+ +Fullscreen sets the window to fullscreen mode. Min/Max size constraints are +disabled.
+ +GetScreen returns the screen that the window is on
+ +GetZoom returns the current zoom level of the window.
+ +Height returns the height of the window
+ +Hide hides the window.
+ +IsFocused returns true if the window is currently focused
+ +IsFullscreen returns true if the window is fullscreen
+ +IsMaximised returns true if the window is maximised
+ +IsMinimised returns true if the window is minimised
+ +IsVisible returns true if the window is visible
+ +Maximise maximises the window. Min/Max size constraints are disabled.
+ +Minimise minimises the window.
+ +Name returns the name of the window
+ +NativeWindowHandle returns the platform native window handle for the window.
+ +func (w *WebviewWindow) On(eventType events.WindowEventType, callback func(event *WindowEvent)) func()
+On registers a callback for the given window event
+ +RegisterContextMenu registers a context menu and assigns it the given name.
+ +func (w *WebviewWindow) RegisterHook(eventType events.WindowEventType, callback func(event *WindowEvent)) func()
+RegisterHook registers a hook for the given window event
+ +RelativePosition returns the relative position of the window to the screen
+ +Reload reloads the page assets
+ +Resizable returns true if the window is resizable.
+ +Restore restores the window to its previous state if it was previously +minimised, maximised or fullscreen.
+ +SetAlwaysOnTop sets the window to be always on top.
+ +SetBackgroundColour sets the background colour of the window
+ +SetFrameless removes the window frame and title bar
+ +SetHTML sets the HTML of the window to the given html string.
+ +SetMaxSize sets the maximum size of the window.
+ +SetMinSize sets the minimum size of the window.
+ +SetRelativePosition sets the position of the window.
+ +SetResizable sets whether the window is resizable.
+ +SetSize sets the size of the window
+ +SetTitle sets the title of the window
+ +SetZoom sets the zoom level of the window.
+ +Show shows the window.
+ +Size returns the size of the window
+ +ToggleFullscreen toggles the window between fullscreen and normal
+ +UnFullscreen un-fullscreens the window.
+ +UnMaximise un-maximises the window.
+ +UnMinimise un-minimises the window. Min/Max size constraints are re-enabled.
+ +Width returns the width of the window
+ +ZoomIn increases the zoom level of the webview content
+ +ZoomOut decreases the zoom level of the webview content
+ +ZoomReset resets the zoom level of the webview content to 100%
+ +type WebviewWindowOptions struct {
+ // Name is a unique identifier that can be given to a window.
+ Name string
+
+ // Title is the title of the window.
+ Title string
+
+ // Width is the starting width of the window.
+ Width int
+
+ // Height is the starting height of the window.
+ Height int
+
+ // AlwaysOnTop will make the window float above other windows.
+ AlwaysOnTop bool
+
+ // URL is the URL to load in the window.
+ URL string
+
+ // DisableResize will disable the ability to resize the window.
+ DisableResize bool
+
+ // Frameless will remove the window frame.
+ Frameless bool
+
+ // MinWidth is the minimum width of the window.
+ MinWidth int
+
+ // MinHeight is the minimum height of the window.
+ MinHeight int
+
+ // MaxWidth is the maximum width of the window.
+ MaxWidth int
+
+ // MaxHeight is the maximum height of the window.
+ MaxHeight int
+
+ // StartState indicates the state of the window when it is first shown.
+ // Default: WindowStateNormal
+ StartState WindowState
+
+ // Centered will center the window on the screen.
+ Centered bool
+
+ // BackgroundType is the type of background to use for the window.
+ // Default: BackgroundTypeSolid
+ BackgroundType BackgroundType
+
+ // BackgroundColour is the colour to use for the window background.
+ BackgroundColour RGBA
+
+ // HTML is the HTML to load in the window.
+ HTML string
+
+ // JS is the JavaScript to load in the window.
+ JS string
+
+ // CSS is the CSS to load in the window.
+ CSS string
+
+ // X is the starting X position of the window.
+ X int
+
+ // Y is the starting Y position of the window.
+ Y int
+
+ // TransparentTitlebar will make the titlebar transparent.
+ // TODO: Move to mac window options
+ FullscreenButtonEnabled bool
+
+ // Hidden will hide the window when it is first created.
+ Hidden bool
+
+ // Zoom is the zoom level of the window.
+ Zoom float64
+
+ // ZoomControlEnabled will enable the zoom control.
+ ZoomControlEnabled bool
+
+ // EnableDragAndDrop will enable drag and drop.
+ EnableDragAndDrop bool
+
+ // OpenInspectorOnStartup will open the inspector when the window is first shown.
+ OpenInspectorOnStartup bool
+
+ // Mac options
+ Mac MacWindow
+
+ // Windows options
+ Windows WindowsWindow
+
+ // Focused indicates the window should be focused when initially shown
+ Focused bool
+
+ // ShouldClose is called when the window is about to close.
+ // Return true to allow the window to close, or false to prevent it from closing.
+ ShouldClose func(window *WebviewWindow) bool
+
+ // If true, the window's devtools will be available (default true in builds without the `production` build tag)
+ DevToolsEnabled bool
+
+ // If true, the window's default context menu will be disabled (default false)
+ DefaultContextMenuDisabled bool
+
+ // KeyBindings is a map of key bindings to functions
+ KeyBindings map[string]func(window *WebviewWindow)
+}
+type WindowAttachConfig struct {
+ // Window is the window to attach to the system tray. If it's null, the request to attach will be ignored.
+ Window *WebviewWindow
+
+ // Offset indicates the gap in pixels between the system tray and the window
+ Offset int
+
+ // Debounce is used by Windows to indicate how long to wait before responding to a mouse
+ // up event on the notification icon. See https://stackoverflow.com/questions/4585283/alternate-showing-hiding-window-when-notify-icon-is-clicked
+ Debounce time.Duration
+ // contains filtered or unexported fields
+}
+const (
+ WindowStateNormal WindowState = iota
+ WindowStateMinimised
+ WindowStateMaximised
+ WindowStateFullscreen
+)
+WindowsOptions contains options for Windows applications.
+type WindowsOptions struct {
+
+ // WndProcInterceptor is a function that will be called for every message sent in the application.
+ // Use this to hook into the main message loop. This is useful for handling custom window messages.
+ // If `shouldReturn` is `true` then `returnCode` will be returned by the main message loop.
+ // If `shouldReturn` is `false` then returnCode will be ignored and the message will be processed by the main message loop.
+ WndProcInterceptor func(hwnd uintptr, msg uint32, wParam, lParam uintptr) (returnCode uintptr, shouldReturn bool)
+
+ // DisableQuitOnLastWindowClosed disables the auto quit of the application if the last window has been closed.
+ DisableQuitOnLastWindowClosed bool
+
+ // Path where the WebView2 stores the user data. If empty %APPDATA%\[BinaryName.exe] will be used.
+ // If the path is not valid, a messagebox will be displayed with the error and the app will exit with error code.
+ WebviewUserDataPath string
+
+ // Path to the directory with WebView2 executables. If empty WebView2 installed in the system will be used.
+ WebviewBrowserPath string
+}
+type WindowsWindow struct {
+ // Select the type of translucent backdrop. Requires Windows 11 22621 or later.
+ // Only used when window's `BackgroundType` is set to `BackgroundTypeTranslucent`.
+ // Default: Auto
+ BackdropType BackdropType
+
+ // Disable the icon in the titlebar
+ // Default: false
+ DisableIcon bool
+
+ // Theme (Dark / Light / SystemDefault)
+ // Default: SystemDefault - The application will follow system theme changes.
+ Theme Theme
+
+ // Specify custom colours to use for dark/light mode
+ // Default: nil
+ CustomTheme *ThemeSettings
+
+ // Disable all window decorations in Frameless mode, which means no "Aero Shadow" and no "Rounded Corner" will be shown.
+ // "Rounded Corners" are only available on Windows 11.
+ // Default: false
+ DisableFramelessWindowDecorations bool
+
+ // WindowMask is used to set the window shape. Use a PNG with an alpha channel to create a custom shape.
+ // Default: nil
+ WindowMask []byte
+
+ // WindowMaskDraggable is used to make the window draggable by clicking on the window mask.
+ // Default: false
+ WindowMaskDraggable bool
+
+ // WebviewGpuIsDisabled is used to enable / disable GPU acceleration for the webview
+ // Default: false
+ WebviewGpuIsDisabled bool
+
+ // ResizeDebounceMS is the amount of time to debounce redraws of webview2
+ // when resizing the window
+ // Default: 0
+ ResizeDebounceMS uint16
+
+ // Disable the menu bar for this window
+ // Default: false
+ DisableMenu bool
+
+ // Event mapping for the window. This allows you to define a translation from one event to another.
+ // Default: nil
+ EventMapping map[events.WindowEventType]events.WindowEventType
+
+ // HiddenOnTaskbar hides the window from the taskbar
+ // Default: false
+ HiddenOnTaskbar bool
+
+ // EnableSwipeGestures enables swipe gestures for the window
+ // Default: false
+ EnableSwipeGestures bool
+
+ // EnableFraudulentWebsiteWarnings will enable warnings for fraudulent websites.
+ // Default: false
+ EnableFraudulentWebsiteWarnings bool
+
+ // Menu is the menu to use for the window.
+ Menu *Menu
+}
+这些方法是在主线程上运行代码的实用函数。当您想要在UI线程上运行自定义代码时，这是 +必需的。
+API: InvokeSync(fn func())
此函数以同步方式运行传入的函数（fn）。它使用一个WaitGroup（wg）确保主线程
+在fn函数完成之前等待，然后才继续执行。如果在fn内部发生恐慌，它将传递给应用程
+序选项中定义的处理程序函数PanicHandler。
API: InvokeSyncWithResult[T any](fn func() T) (res T)
此函数与InvokeSync(fn func())类似，但它返回一个结果。可用于调用具有单个返回值
+的任何函数。
API: InvokeSyncWithError(fn func() error) (err error)
此函数同步运行fn并返回fn产生的任何错误。请注意，如果在fn执行期间发生恐慌，
+此函数将从恢复。
API:
+InvokeSyncWithResultAndError[T any](fn func() (T, error)) (res T, err error)
此函数同步运行fn并返回类型为T的结果和一个错误。
API: InvokeAsync(fn func())
此函数以异步方式运行fn。它在主线程上运行给定的函数。如果在fn内部发生恐慌，它
+将传递给应用程序选项中定义的处理程序函数PanicHandler。
注意：这些函数将阻塞执行，直到fn完成。确保fn不会阻塞至关重要。如果需要运行阻
+塞函数，请改用InvokeAsync。
可以创建菜单并添加到应用程序中。它们可以用于创建上下文菜单、系统托盘菜单和应用程 +序菜单。
+要创建一个新菜单，请调用：
+ +然后，Menu 类型上可用以下操作：
API：Add(label string) *MenuItem
此方法以 string 类型的 label 作为输入，并将具有给定标签的新 MenuItem 添加
+到菜单中。它返回添加的 MenuItem。
API：AddSeparator()
此方法将一个新的分隔符 MenuItem 添加到菜单中。
API：AddCheckbox(label string, enabled bool) *MenuItem
此方法以 string 类型的 label 和 bool 类型的 enabled 作为输入，并将具有给
+定标签和启用状态的新复选框 MenuItem 添加到菜单中。它返回添加的 MenuItem。
API：AddRadio(label string, enabled bool) *MenuItem
此方法以 string 类型的 label 和 bool 类型的 enabled 作为输入，并将具有给
+定标签和启用状态的新单选按钮 MenuItem 添加到菜单中。它返回添加的 MenuItem。
API：Update()
此方法处理任何单选按钮组，并在菜单未初始化时更新菜单。
+API：AddSubmenu(s string) *Menu
此方法以 string 类型的 s 作为输入，并将具有给定标签的新子菜单 MenuItem 添
+加到菜单中。它返回添加的子菜单。
API：AddRole(role Role) *Menu
此方法以 Role 类型的 role 作为输入，如果不为 nil，则将其添加到菜单中，并返
+回 Menu。
API：SetLabel(label string)
此方法设置 Menu 的 label。
系统托盘位于桌面环境的通知区域，可以包含当前运行应用程序的图标和特定系统通知。
+您可以通过调用 app.NewSystemTray() 来创建一个系统托盘：
SystemTray 类型上提供了以下方法：
API：SetLabel(label string)
SetLabel 方法设置托盘的标签。
API：Label() string
Label 方法获取托盘的标签。
API：PositionWindow(*WebviewWindow, offset int) error
PositionWindow 方法调用了 AttachWindow 和 WindowOffset 方法。
API：SetIcon(icon []byte) *SystemTray
SetIcon 方法设置系统托盘的图标。
API：SetDarkModeIcon(icon []byte) *SystemTray
SetDarkModeIcon 方法设置暗黑模式下系统托盘的图标。
API：SetMenu(menu *Menu) *SystemTray
SetMenu 方法设置系统托盘的菜单。
API：Destroy()
Destroy 方法销毁系统托盘实例。
API：OnClick(handler func()) *SystemTray
OnClick 方法设置点击托盘图标时执行的函数。
API：OnRightClick(handler func()) *SystemTray
OnRightClick 方法设置右键点击托盘图标时执行的函数。
API：OnDoubleClick(handler func()) *SystemTray
OnDoubleClick 方法设置双击托盘图标时执行的函数。
API：OnRightDoubleClick(handler func()) *SystemTray
OnRightDoubleClick 方法设置右键双击托盘图标时执行的函数。
API：AttachWindow(window *WebviewWindow) *SystemTray
AttachWindow 方法将窗口附加到系统托盘。当点击系统托盘图标时，窗口将显示出来。
API：WindowOffset(offset int) *SystemTray
WindowOffset 方法设置系统托盘与窗口之间的像素间隔。
API：WindowDebounce(debounce time.Duration) *SystemTray
WindowDebounce 方法设置防抖时间。在 Windows 上，它用于指定在响应通知图标上的鼠
+标松开事件之前等待多长时间。
API：OpenMenu()
OpenMenu 方法打开与系统托盘关联的菜单。
要创建一个窗口，可以使 +用Application.NewWebviewWindow或Application.NewWebviewWindowWithOptions。 +前者创建一个具有默认选项的窗口，而后者允许您指定自定义选项。
+这些方法可在返回的WebviewWindow对象上调用：
+API: SetTitle(title string) *WebviewWindow
此方法将窗口标题更新为提供的字符串。它返回WebviewWindow对象，允许进行方法链接。
+API: Name() string
此函数返回WebviewWindow的名称。
+API: SetSize(width, height int) *WebviewWindow
此方法将WebviewWindow的大小设置为提供的宽度和高度参数。如果提供的尺寸超过约束条 +件，它们将被相应调整。
+API: SetAlwaysOnTop(b bool) *WebviewWindow
此函数根据提供的布尔标志设置窗口始终置顶。
+API: Show() *WebviewWindow
Show方法用于使窗口可见。如果窗口未运行，它首先调用run方法启动窗口，然后使其
+可见。
API: Hide() *WebviewWindow
Hide方法用于隐藏窗口。它将窗口的隐藏状态设置为true，并触发窗口隐藏事件。
API: SetURL(s string) *WebviewWindow
SetURL方法用于将窗口的URL设置为给定的URL字符串。
API: SetZoom(magnification float64) *WebviewWindow
SetZoom方法将窗口内容的缩放级别设置为提供的放大倍数。
API: GetZoom() float64
GetZoom函数返回窗口内容的当前缩放级别。
API: GetScreen() (*Screen, error)
GetScreen方法返回窗口所显示的屏幕。
API: SetFrameless(frameless bool) *WebviewWindow
此函数用于移除窗口边框和标题栏。它根据提供的布尔值（true表示无边框，false表示有 +边框）切换窗口的无边框状态。
+API: RegisterContextMenu(name string, menu *Menu)
此函数用于注册上下文菜单并为其指定给定的名称。
+API: NativeWindowHandle() (uintptr, error)
此函数用于获取窗口的平台本机窗口句柄。
+API: Focus()
此函数用于将焦点设置到窗口。
+API: SetEnabled(enabled bool)
此函数用于根据提供的布尔值启用/禁用窗口。
+API: SetAbsolutePosition(x int, y int)
此函数设置窗口在屏幕上的绝对位置。
+ + + + + + + + + + + + + +!!! note这是当前的无序更改脑升级。很快它将组织成一个更易读的格式。
+自v2以来，应用程序选项已经进行了修订。
+在v3中，有3种类型的事件：
+应用程序事件是由应用程序发出的事件。这些事件包括macOS上
+的ApplicationDidFinishLaunching等本机事件。
窗口事件是由窗口发出的事件。这些事件包括macOS上的WindowDidBecomeMain等本机事
+件。还定义了常见事件，以便它们在跨平台上工作，例如WindowClosing。
用户定义的事件称为WailsEvents。这是为了将它们与用于与浏览器通信的Event对象区
+分开来。WailsEvents现在是封装事件的对象。这包括事件名称，数据和事件的源。
与WailsEvent关联的数据现在是单个值。如果需要多个值，则可以使用struct。
+Emit函数签名事件回调的签名（由On，Once和OnMultiple使用）已更改。在v2中，回调函数接收可
+选数据。在v3中，回调函数接收包含与事件相关的所有数据的WailsEvent对象。
类似地，Emit函数已更改。它现在不再接受名称和可选数据，而是接受一
+个WailsEvent对象，它将发出该对象。
Off和OffAll在v2中，Off和OffAll调用将删除JS和Go中的事件。由于v3具有多窗口的特性，因此已
+更改为这些方法仅适用于调用它们的上下文。例如，如果你在一个窗口中调用Off，它仅
+会删除该窗口的事件。如果你在Go中使用Off，它只会删除Go的事件。
事件钩子是v3中的新功能。它们允许您钩入事件系统，并在发出某些事件时执行操作。例
+如，您可以钩入WindowClosing事件，在窗口关闭之前执行一些清理操作。钩子可以在应
+用程序级别或窗口级别使用RegisterHook进行注册。应用程序级别适用于应用程序事件。
+仅当窗口级别钩子与其注册的窗口一起调用。
在v2中，日志记录会混淆，因为应用程序日志和系统（内部）日志都使用相同的记录器。我 +们已经对此进行了简化：
+slog记录器处理。这是通过应用程序选项中的logger选
+ 项进行配置的。默认情况下，这使用tint记录
+ 器。log插件进行应用程序日志记录，它在底层使用slog。此插件提供
+ 了一个简单的用于记录到控制台的API。它在Go和JS中都可用。在Go中发出事件时，它会将事件分派到本地的Go侦听器以及应用程序中的每个窗口。在JS中 +发出事件时，它现在会将事件发送到应用程序。这将被处理，就好像它是在Go中发出的，但 +是发送者ID将是窗口的ID。
+Window API在很大程度上保持不变，但方法现在是在窗口实例而不是运行时上。一些值得注 +意的变化是：
+AbsolutePosition和ToggleDevTools。剪贴板API已经简化。现在有一个单独的Clipboard对象，可以用于读取和写入剪贴
+板。Clipboard对象在Go和JS中都可用。SetText()用于设置文本，Text()用于获取文
+本。
绑定的工作方式与v2类似，通过提供一种将结构方法绑定到前端的方式。这些可以在前端使
+用由wails3 generate bindings命令生成的绑定包装器来调用：
// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+import { main } from "./models";
+
+window.go = window.go || {};
+window.go.main = {
+ GreetService: {
+ /**
+ * GreetService.Greet
+ * Greet greets a person
+ * @param name {string}
+ * @returns {Promise<string>}
+ **/
+ Greet: function (name) {
+ wails.CallByID(1411160069, ...Array.prototype.slice.call(arguments, 0));
+ },
+
+ /**
+ * GreetService.GreetPerson
+ * GreetPerson greets a person
+ * @param person {main.Person}
+ * @returns {Promise<string>}
+ **/
+ GreetPerson: function (person) {
+ wails.CallByID(4021313248, ...Array.prototype.slice.call(arguments, 0));
+ },
+ },
+};
+默认情况下，绑定的方法是混淆的，并使用uint32 ID进行标识，该ID是使
+用FNV哈希算法计
+算的。这是为了防止方法名称在生产构建中被暴露出来。在调试模式下，方法ID与计算的方
+法ID一起记录，以帮助调试。如果您希望增加额外的混淆层，可以使用BindAliases选
+项。这允许您指定别名ID与方法ID的映射。当前端使用ID调用方法时，方法ID将首先在别名
+映射中查找匹配项。如果找不到，它将假定是标准方法ID，并尝试以通常的方式查找方法。
示例：
+ app := application.New(application.Options{
+ Bind: []any{
+ &GreetService{},
+ },
+ BindAliases: map[uint32]uint32{
+ 1: 1411160069,
+ 2: 4021313248,
+ },
+ Assets: application.AssetOptions{
+ FS: assets,
+ },
+ Mac: application.MacOptions{
+ ApplicationShouldTerminateAfterLastWindowClosed: true,
+ },
+ })
+现在我们可以使用此别名在前端调用：wails.Call(1, "world!")。
如果您不介意在二进制文件中以明文形式提供调用，并且不打算使
+用garble，那么可以使用不安全
+的wails.CallByName()方法。此方法接受要调用的方法的完全限定名称和要传递给它的参
+数。示例：
```go
+wails.CallByName("main.GreetService.Greet", "world!")
+```
+Danger
+这仅作为开发的便利方法提供。不建议在生产中使用此方法。
+对话框现在在JavaScript中可用！
+Windows中的对话框按钮是不可配置的，根据对话框的类型是恒定的。要在按下按钮时触发
+回调，请创建一个具有与您希望附加回调的按钮相同名称的按钮。示例：创建一个标签为“
+确定”的按钮，并使用OnClick()方法设置回调方法：
dialog := app.QuestionDialog().
+ SetTitle("Update").
+ SetMessage("The cancel button is selected when pressing escape")
+ ok := dialog.AddButton("Ok")
+ ok.OnClick(func() {
+ // Do something
+ })
+ no := dialog.AddButton("Cancel")
+ dialog.SetDefaultButton(ok)
+ dialog.SetCancelButton(no)
+ dialog.Show()
+可以按窗口启用本机拖放。只需将EnableDragAndDrop窗口配置选项设置为true，窗口
+将允许将文件拖放到其上。当这种情况发生时，将发出events.FilesDropped事件。然后
+可以使用WindowEvent.Context()中的DroppedFiles()方法检索文件名。这将返回一个
+包含文件名的字符串切片。
上下文菜单是当用户右键单击元素时显示的上下文菜单。创建上下文菜单与创建标准菜单相
+同，使用app.NewMenu()。要使上下文菜单对窗口可用，请调
+用window.RegisterContextMenu(name, menu)。名称将是上下文菜单的ID，并由前端使
+用。
要指示元素具有上下文菜单，请将data-contextmenu属性添加到元素。此属性的值应为先
+前在窗口中注册的上下文菜单的名称。
可以在应用程序级别注册上下文菜单，使其对所有窗口可用。可以使
+用app.RegisterContextMenu(name, menu)完成此操作。如果在窗口级别找不到上下文菜
+单，则将检查应用程序上下文菜单。v3/examples/contextmenus中可以找到此演示。
Wails标记语言是一种简单的标记语言，允许您在没有JavaScript的情况下向标准HTML元素 +添加功能。
+当前支持以下标签：
+data-wml-event这指定单击元素时将发出Wails事件。属性的值应为要发出的事件的名称。
+示例：
+ +有时您需要用户确认操作。可以通过向元素添加data-wml-confirm属性来完成。此属性的
+值将是要显示给用户的消息。
示例：
+<button data-wml-event="delete-all-items" data-wml-confirm="Are you sure?">
+ Delete All Items
+</button>
+data-wml-window可以通过将data-wml-window属性添加到元素中来调用任何wails.window方法。属性的
+值应为要调用的方法的名称。方法名称应与导出的方法的名称完全匹配。
data-wml-trigger此属性指定应触发操作的javascript事件。默认为click。
Wails 3附带了一个内置的系统托盘。这是一个完全功能的系统托盘，旨在尽可能简单地使 +用。可以设置托盘的图标、工具提示和菜单。还可以“附加”窗口到系统托盘。这样做将提供 +以下功能：
+在macOS上，如果没有附加的窗口，则托盘将使用显示菜单的默认方法（任何按钮）。如果 +有附加的窗口但没有菜单，则托盘将切换窗口，而不管按下的按钮如何。
+插件是扩展Wails应用程序功能的一种方式。
+插件是符合以下接口的标准Go结构：
+type Plugin interface {
+ Name() string
+ Init(*application.App) error
+ Shutdown()
+ CallableByJS() []string
+ InjectJS() string
+}
+Name()方法返回插件的名称。这用于记录目的。
Init(*application.App) error方法在加载插件时调用。*application.App参数是加载
+插件的应用程序。任何错误都将阻止应用程序启动。
Shutdown()方法在应用程序关闭时调用。
CallableByJS()方法返回可以从前端调用的导出函数列表。这些方法名称必须与插件导出
+的方法名称完全匹配。
InjectJS()方法返回应注入到创建的所有窗口中的JavaScript。这对于添加与插件补充的
+自定义JavaScript函数很有用。
在Go中，枚举通常被定义为类型和一组常量。例如：
+ +由于Go和JavaScript之间的不兼容性，无法以这种方式使用自定义类型。最好的策略是为 +float64使用类型别名：
+ +在Javascript中，您可以使用以下代码：
+ +float64？不能使用int吗？number，在Go中会转换为float64。Go
+ 的反射包中还有类型转换的限制，这意味着使用int是行不通的。在v2中，这是指向RGBA结构的指针。在v3中，这是RGBA结构的值。
已删除此标志。现在有一个BackgroundType标志，可用于设置窗口应具有的背景类型。此
+标志可以设置为以下任何值：
BackgroundTypeSolid - 窗口将具有实心背景BackgroundTypeTransparent - 窗口将具有透明背景BackgroundTypeTranslucent - 窗口将具有半透明背景在Windows上，如果BackgroundType设置为BackgroundTypeTranslucent，则可以使
+用WindowsWindow选项中的BackdropType标志设置透明度的类型。这可以设置为以下任
+何值：
Auto - 窗口将使用系统确定的效果None - 窗口没有背景Mica - 窗口使用Mica效果Acrylic - 窗口使用丙烯酸效果Tabbed - 窗口使用选项卡效果如果设置了此标志，将拦截WndProc并调用该函数。这允许您直接处理Windows消息。该函数 +应具有以下签名：
+ +如果shouldReturn值设置为true，则returnValue将由主wndProc方法返回。如果设置
+为false，将忽略返回值，并且消息将继续由主wndProc方法处理。
在v2中，有一个HideWindowOnClose标志，用于在关闭窗口时隐藏窗
+口。HideWindowOnClose标志与OnBeforeClose回调之间存在逻辑重叠。在v3中，已删
+除HideWindowOnClose标志，并将OnBeforeClose回调重命名为ShouldClose。当用户
+尝试关闭窗口时，将调用ShouldClose回调。如果回调返回true，窗口将关闭。如果返
+回false，窗口将不会关闭。这可以用于隐藏窗口而不是关闭窗口。
在v2中，使用--wails-drag属性来指示可以使用元素拖动窗口。在v3中，已将其替换
+为--webkit-app-region，以更符合其他框架处理方式。--webkit-app-region属性可以
+设置为以下任何值：
drag - 可使用该元素拖动窗口no-drag - 该元素无法用于拖动窗口我们本来希望使用app-region，但是在webkit在macOS上的getComputedStyle调用不支
+持它。
!!! note 这个指南仍在制作中。
+感谢您想要帮助开发Wails！本指南将帮助您入门。
+v3-alpha 分支。安装 CLI：cd v3/cmd/wails3 && go install
可选：如果您想要使用构建系统构建前端代码，您需要安装 + npm。
+对于简单的程序，您可以使用标准的 go build 命令。也可以使用 go run。
Wails 还配备了一个构建系统，可用于构建更复杂的项目。它使用了强大的
+Task 构建系统。要了解更多信息，请查看任务主页或运行
+wails task --help。
该项目具有以下结构：
+```
+v3
+├── cmd/wails3 // CLI
+├── examples // Wails 应用示例
+├── internal // 内部包
+| ├── runtime // Wails JS 运行时
+| └── templates // 支持的项目模板
+├── pkg
+| ├── application // 核心 Wails 库
+| └── events // 事件定义
+| └── mac // 由插件使用的 macOS 特定代码
+| └── w32 // Windows 特定代码
+├── plugins // 支持的插件
+├── tasks // 通用任务
+└── Taskfile.yaml // 开发任务配置
+```
+添加窗口功能的首选方法是在 pkg/application/webview_window.go 文件中添加一个新
+函数。这应该实现所有平台所需的功能。任何特定于平台的代码都应通过
+webviewWindowImpl 接口方法调用。该接口由每个目标平台实现，以提供平台特定的功
+能。在某些情况下，这可能不执行任何操作。添加接口方法后，请确保每个平台都实现了
+它。一个很好的例子是 SetMinSize 方法。
webview_window_darwin.gowebview_window_windows.gowebview_window_linux.go大多数，如果不是全部，特定于平台的代码应在主线程上运行。为了简化这一点，在
+application.go 中定义了一些 invokeSync 方法。
运行时位于 v3/internal/runtime。更新运行时时，需要执行以下步骤：
事件定义在 v3/pkg/events 中。当添加新事件时，需要执行以下步骤：
events.txt 文件中wails3 task events:generate有几种类型的事件：特定于平台的应用程序和窗口事件 + 通用事件。通用事件对于跨平台 +事件处理很有用，但您不必局限于“最低公共分母”。如果需要，可以使用特定于平台的事 +件。
+添加通用事件时，请确保映射了特定于平台的事件。一个示例是在
+window_webview_darwin.go 中：
// 将 ShouldClose 转化为通用的 WindowClosing 事件
+ w.parent.On(events.Mac.WindowShouldClose, func(_ *WindowEventContext) {
+ w.parent.emit(events.Common.WindowClosing)
+ })
+注意：我们可能会尝试通过将映射添加到事件定义中来自动化此过程。
+插件是扩展 Wails 应用功能的一种方式。
+插件是符合以下接口的标准 Go 结构：
+type Plugin interface {
+ Name() string
+ Init(*application.App) error
+ Shutdown()
+ CallableByJS() []string
+ InjectJS() string
+}
+Name() 方法返回插件的名称。这用于日志记录。
Init(*application.App) error 方法在加载插件时调用。*application.App 参数是加
+载插件的应用程序。任何错误都将阻止应用程序启动。
Shutdown() 方法在应用程序关闭时调用。
CallableByJS() 方法返回可以从前端调用的导出函数列表。这些方法的名称必须与插件
+导出的方法的名称完全匹配。
InjectJS() 方法返回应注入到所有窗口中的 JavaScript。这对于添加与插件相补充的自
+定义 JavaScript 函数非常有用。
内置插件可以在 v3/plugins 目录中找到。参考它们以获得灵感。
Wails CLI 使用 Task 构建系统。它作为库导入并用于运行
+Taskfile.yaml 中定义的任务。与 Task 的主要交互发生在
+v3/internal/commands/task.go 中。
要检查是否有 Taskfile 的升级，请运行 wails3 task -version 并检查 Task 网站。
要升级使用的 Taskfile 版本，请运行：
+ +如果存在不兼容性，则应在 v3/internal/commands/task.go 文件中显示。
通常，修复不兼容性的最佳方法是克隆 https://github.com/go-task/task 上的任务存
+储库，并查看 git 历史记录以确定发生了什么变化以及原因。
要检查所有更改是否正确工作，请重新安装 CLI 并再次检查版本：
+ +确保所有 PR 都有与之关联的工单，以提供更改的上下文。如果没有工单，请先创建一个。
+确保所有 PR 都已使用所做的更改更新了 CHANGELOG.md 文件。CHANGELOG.md 文件位于
+mkdocs-website/docs 目录中。
Wails CLI 使用 Task 构建系统。它作为库导入并用于运行
+Taskfile.yaml 中定义的任务。与 Task 的主要交互发生在
+v3/internal/commands/task.go 中。
要检查是否有 Taskfile 的升级，请运行 wails3 task -version 并检查 Task 网站。
要升级使用的 Taskfile 版本，请运行：
+ +如果存在不兼容性，则应在 v3/internal/commands/task.go 文件中显示。
通常，修复不兼容性的最佳方法是克隆 https://github.com/go-task/task 上的任务存
+储库，并查看 git 历史记录以确定发生了什么变化以及原因。
要检查所有更改是否正确工作，请重新安装 CLI 并再次检查版本：
+ + + + + + + + + + + + + + +将以下文本翻译为中文，并不要翻译 !!! note 或 !!! tip 或以此格式的字符串：
v3版功能的状态。
+Note
+此列表包含公有和内部API支持的混合内容。<br/>
+它不完整且可能不是最新的。
+应用程序接口方法
+| 方法 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| run() error | +Y | +Y | +Y | ++ |
| destroy() | ++ | Y | +Y | ++ |
| setApplicationMenu(menu *Menu) | +Y | +Y | +Y | ++ |
| name() string | ++ | Y | +Y | ++ |
| getCurrentWindowID() uint | +Y | +Y | +Y | ++ |
| showAboutDialog(name string, description string, icon []byte) | ++ | Y | +Y | ++ |
| setIcon(icon []byte) | +- | +Y | +Y | ++ |
| on(id uint) | ++ | + | Y | ++ |
| dispatchOnMainThread(fn func()) | +Y | +Y | +Y | ++ |
| hide() | +Y | +Y | +Y | ++ |
| show() | +Y | +Y | +Y | ++ |
| getPrimaryScreen() (*Screen, error) | ++ | Y | +Y | ++ |
| getScreens() ([]*Screen, error) | ++ | Y | +Y | ++ |
Webview 窗口接口方法
+| 方法 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| center() | +Y | +Y | +Y | ++ |
| close() | +y | +Y | +Y | ++ |
| destroy() | ++ | Y | +Y | ++ |
| execJS(js string) | +y | +Y | +Y | ++ |
| focus() | +Y | +Y | ++ | + |
| forceReload() | ++ | Y | +Y | ++ |
| fullscreen() | +Y | +Y | +Y | ++ |
| getScreen() (*Screen, error) | +y | +Y | +Y | ++ |
| getZoom() float64 | ++ | Y | +Y | ++ |
| height() int | +Y | +Y | +Y | ++ |
| hide() | +Y | +Y | +Y | ++ |
| isFullscreen() bool | +Y | +Y | +Y | ++ |
| isMaximised() bool | +Y | +Y | +Y | ++ |
| isMinimised() bool | +Y | +Y | +Y | ++ |
| maximise() | +Y | +Y | +Y | ++ |
| minimise() | +Y | +Y | +Y | ++ |
| nativeWindowHandle() (uintptr, error) | +Y | +Y | ++ | + |
| on(eventID uint) | +y | ++ | Y | ++ |
| openContextMenu(menu Menu, data ContextMenuData) | +y | ++ | Y | ++ |
| relativePosition() (int, int) | +Y | +Y | +Y | ++ |
| reload() | +y | +Y | +Y | ++ |
| run() | +Y | +Y | +Y | ++ |
| setAlwaysOnTop(alwaysOnTop bool) | +Y | +Y | +Y | ++ |
| setBackgroundColour(color RGBA) | +Y | +Y | +Y | ++ |
| setEnabled(bool) | ++ | Y | +Y | ++ |
| setFrameless(bool) | ++ | Y | +Y | ++ |
| setFullscreenButtonEnabled(enabled bool) | +- | +Y | +Y | +Windows 没有全屏按钮 | +
| setHTML(html string) | +Y | +Y | +Y | ++ |
| setMaxSize(width, height int) | +Y | +Y | +Y | ++ |
| setMinSize(width, height int) | +Y | +Y | +Y | ++ |
| setRelativePosition(x int, y int) | +Y | +Y | +Y | ++ |
| setResizable(resizable bool) | +Y | +Y | +Y | ++ |
| setSize(width, height int) | +Y | +Y | +Y | ++ |
| setTitle(title string) | +Y | +Y | +Y | ++ |
| setURL(url string) | +Y | +Y | +Y | ++ |
| setZoom(zoom float64) | +Y | +Y | +Y | ++ |
| show() | +Y | +Y | +Y | ++ |
| size() (int, int) | +Y | +Y | +Y | ++ |
| toggleDevTools() | +Y | +Y | +Y | ++ |
| unfullscreen() | +Y | +Y | +Y | ++ |
| unmaximise() | +Y | +Y | +Y | ++ |
| unminimise() | +Y | +Y | +Y | ++ |
| width() int | +Y | +Y | +Y | ++ |
| zoom() | ++ | Y | +Y | ++ |
| zoomIn() | +Y | +Y | +Y | ++ |
| zoomOut() | +Y | +Y | +Y | ++ |
| zoomReset() | +Y | +Y | +Y | ++ |
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 退出 | +Y | +Y | +Y | ++ |
| 隐藏 | +Y | ++ | Y | ++ |
| 显示 | +Y | ++ | Y | ++ |
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 信息 | +Y | +Y | +Y | ++ |
| 警告 | +Y | +Y | +Y | ++ |
| 错误 | +Y | +Y | +Y | ++ |
| 问题 | +Y | +Y | +Y | ++ |
| 打开文件 | +Y | ++ | Y | ++ |
| 保存文件 | +Y | ++ | Y | ++ |
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 设置文本 | +Y | ++ | Y | ++ |
| 文本 | +Y | ++ | Y | ++ |
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 打开上下文菜单 | +Y | ++ | Y | ++ |
| 默认开启 | ++ | + | + | + |
| 通过 HTML 控制 | +Y | ++ | + | + |
默认上下文菜单默认对所有contentEditable: true、<input>或<textarea>标签的元
+素或具有--default-contextmenu: true样式的元素启
+用。--default-contextmenu: show样式将始终显示上下文菜
+单。--default-contextmenu: hide样式将始终隐藏上下文菜单。
嵌套在带有--default-contextmenu: hide样式的标签下的任何内容，除非使
+用--default-contextmenu: show进行显式设置，否则不会显示上下文菜单。
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 获取所有 | +Y | +Y | +Y | ++ |
| 获取主屏幕 | +Y | +Y | +Y | ++ |
| 获取当前屏幕 | +Y | +Y | +Y | ++ |
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 是否为暗模式 | ++ | + | Y | ++ |
Y = 支持 U = 未经测试
+| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 居中 | +Y | +Y | +Y | ++ |
| 获得焦点 | +Y | +Y | ++ | + |
| 全屏 | +Y | +Y | +Y | ++ |
| 获得缩放比例 | +Y | +Y | +Y | +获取当前视图比例 | +
| 高度 | +Y | +Y | +Y | ++ |
| 隐藏 | +Y | +Y | +Y | ++ |
| 最大化 | +Y | +Y | +Y | ++ |
| 最小化 | +Y | +Y | +Y | ++ |
| 相对位置 | +Y | +Y | +Y | ++ |
| 屏幕 | +Y | +Y | +Y | +获取窗口的屏幕 | +
| 设置始终在顶部 | +Y | +Y | +Y | ++ |
| 设置背景颜色 | +Y | +Y | +Y | +https://github.com/MicrosoftEdge/WebView2Feedback/issues/1621#issuecomment-938234294 | +
| 设置启用状态 | +Y | +U | +- | +设置窗口是否可用 | +
| 设置最大尺寸 | +Y | +Y | +Y | ++ |
| 设置最小尺寸 | +Y | +Y | +Y | ++ |
| 设置相对位置 | +Y | +Y | +Y | ++ |
| 设置是否可调整大小 | +Y | +Y | +Y | ++ |
| 设置大小 | +Y | +Y | +Y | ++ |
| 设置标题 | +Y | +Y | +Y | ++ |
| 设置缩放比例 | +Y | +Y | +Y | +设置视图比例 | +
| 显示 | +Y | +Y | +Y | ++ |
| 尺寸 | +Y | +Y | +Y | ++ |
| 取消全屏 | +Y | +Y | +Y | ++ |
| 取消最大化 | +Y | +Y | +Y | ++ |
| 取消最小化 | +Y | +Y | +Y | ++ |
| 宽度 | +Y | +Y | +Y | ++ |
| 缩放 | ++ | Y | +Y | ++ |
| 放大 | +Y | +Y | +Y | +增加视图比例 | +
| 缩小 | +Y | +Y | +Y | +减小视图比例 | +
| 重置缩放 | +Y | +Y | +Y | +重置视图比例 | +
下表中的'Y'表示已经测试并且在窗口创建时应用了该选项。'X'表示该平台不支持该选项。
+| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 始终在顶部 | +Y | ++ | + | + |
| 背景颜色 | +Y | +Y | ++ | + |
| 背景类型 | ++ | + | + | 默认情况下，亚克力效果有效，其他无效 | +
| CSS | +Y | +Y | ++ | + |
| DevToolsEnabled | +Y | +Y | +Y | ++ |
| DisableResize | +Y | +Y | ++ | + |
| 启用拖放 | ++ | Y | ++ | + |
| 启用欺诈网站警告 | ++ | + | + | + |
| 获得焦点 | +Y | +Y | ++ | + |
| 无边框 | +Y | +Y | ++ | + |
| 启用全屏按钮 | +Y | ++ | + | Windows上没有全屏按钮 | +
| HTML | +Y | +Y | ++ | + |
| JS | +Y | +Y | ++ | + |
| Mac | +- | +- | ++ | + |
| 最大高度 | +Y | +Y | ++ | + |
| 最大宽度 | +Y | +Y | ++ | + |
| 最小高度 | +Y | +Y | ++ | + |
| 最小宽度 | +Y | +Y | ++ | + |
| 名称 | +Y | +Y | ++ | + |
| 启动时打开检查器 | ++ | + | + | + |
| 启动状态 | +Y | ++ | + | + |
| 标题 | +Y | +Y | ++ | + |
| URL | +Y | +Y | ++ | + |
| 宽度 | +Y | +Y | ++ | + |
| Windows | +Y | +- | +- | ++ |
| X | +Y | +Y | ++ | + |
| Y | +Y | +Y | ++ | + |
| 缩放 | ++ | + | + | + |
| 启用缩放控件 | ++ | + | + | + |
要记录还是不要记录？系统日志器与自定义日志器。
+| 事件 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 默认应用程序菜单 | +Y | +Y | +Y | ++ |
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 图标 | +Y | ++ | Y | +Windows具有默认的浅色/深色模式图标并支持PNG或ICO。 | +
| 标签 | +- | ++ | Y | ++ |
| 标签（ANSI码） | +- | ++ | + | + |
| 菜单 | +Y | ++ | Y | ++ |
| 方法 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| setLabel(label string) | +- | ++ | Y | ++ |
| run() | +Y | ++ | Y | ++ |
| setIcon(icon []byte) | +Y | ++ | Y | ++ |
| setMenu(menu *Menu) | +Y | ++ | Y | ++ |
| setIconPosition(position int) | +- | ++ | Y | ++ |
| setTemplateIcon(icon []byte) | +- | ++ | Y | ++ |
| destroy() | +Y | ++ | Y | ++ |
| setDarkModeIcon(icon []byte) | +Y | ++ | Y | ++ |
将本机事件映射到跨平台事件。
+| 事件 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| WindowWillClose | ++ | + | WindowWillClose | ++ |
| WindowDidClose | ++ | + | + | + |
| WindowDidResize | ++ | + | + | + |
| WindowDidHide | ++ | + | + | + |
| ApplicationWillTerminate | ++ | + | + | + |
... 添加更多
+工作正常。
+工作正常。
+包含很多开发所需的内容。
+| 模式 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 暗 | +Y | ++ | + | + |
| 亮 | +Y | ++ | + | + |
| 系统 | +Y | ++ | + | + |
待定
+所有模板都可用。
+内置插件支持：
+| 插件 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 浏览器 | +Y | ++ | Y | ++ |
| KV 存储 | +Y | +Y | +Y | ++ |
| 日志 | +Y | +Y | +Y | ++ |
| 单实例 | +Y | ++ | Y | ++ |
| SQLite | +Y | +Y | +Y | ++ |
| 开机自启动 | +Y | ++ | Y | ++ |
| 服务器 | ++ | + | + | + |
待办事项：
+| + | Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 图标生成 | +Y | ++ | Y | ++ |
| 图标嵌入 | +Y | ++ | Y | ++ |
| Info.plist | +- | ++ | Y | ++ |
| NSIS 安装程序 | ++ | + | - | ++ |
| Mac 包 | +- | ++ | Y | ++ |
| Windows 可执行文件 | +Y | ++ | - | ++ |
| 功能 | +Windows | +Linux | +Mac | +备注 | +
|---|---|---|---|---|
| 调整大小 | +Y | ++ | Y | ++ |
| 拖拽 | +Y | +Y | +Y | +Linux-始终可以使用 Meta+左键拖拽 |
+
| 功能 | +默认值 | +备注 | +
|---|---|---|
| 背景 | +MacBackdropNormal | +标准的实心窗口 | +
| 禁用阴影 | +false | ++ |
| 标题栏 | ++ | 默认情况下使用标准的窗口装饰 | +
| 外观 | +DefaultAppearance | ++ |
| 隐藏标题栏高度 | +0 | +为无边框窗口创建一个不可见的标题栏 | +
| 禁用阴影 | +false | +禁用窗口投影阴影 | +
| 功能 | +默认值 | +备注 | +
|---|---|---|
| 背景类型 | +Solid | ++ |
| 禁用图标 | +false | ++ |
| 主题 | +SystemDefault | ++ |
| 自定义主题 | +nil | ++ |
| 禁用无边框窗口装饰 | +false | ++ |
| 窗口遮罩 | +nil | +使窗口成为位图的内容 | +
由*_linux.go文件使用的函数的实现详细信息位于以下文件中：
默认情况下，使用 CGO 编译 Linux 端口。这会阻止轻松的交叉编译，因此同时也正在同时 +开发 PureGo 实现。
+可以使用以下命令编译示例：
+CGO_ENABLED=0 go build -tags purego
+注意：重构之后的功能目前无法正常工作。
+ + + + + + + + + + + + + +我们欢迎（并鼓励）您的反馈！在创建新的反馈之前，请先搜索现有的票据或帖子。以下是 +提供反馈的不同方式：
+如果您发现错误，请在Discord的v3 Alpha Feedback频道中发布信息：
+Bug。wails doctor的输出。如果您有一个错误的修复或文档的更新，请执行以下操作：
+[v3 alpha]开头。PR。表情符号给帖子投票。请对您认为优先级较高的帖子进行投票。已知问题和正在进行的工作列表可以 +在此处找到。
+要安装Wails CLI，请确保已经安装Go 1.21+并运行以下命令：
+git clone https://github.com/wailsapp/wails.git
+cd wails
+git checkout v3-alpha
+cd v3/cmd/wails3
+go install
+在安装之前，Wails有一些常见的依赖项需要安装：
+从Go下载页面下载Go。
+确保按照官方的Go安装指南进行操作。您还需要确保您的PATH环境变量中包含~/go/bin目录的路径。重新启动终端并进行以下检查：
go version~/go/bin是否在您的PATH变量中：echo $PATH | grep go/bin虽然Wails不需要安装npm，但如果您想使用捆绑的模板，则需要安装npm。
+从Node下载页面下载最新的node安装程序。最好使用最新的版本，因为这是我们通常进行测试的版本。
+运行npm --version进行验证。
Wails CLI嵌入了一个名为Task的任务运行器。这是可选的，但建议安装。如果您不想安装Task，可以使用wails3 task命令代替task。
+安装Task将给您最大的灵活性。
您还需要安装特定于平台的依赖项：
+Wails要求安装WebView2 Runtime。一些Windows安装可能已经安装了此软件。您可以使用wails doctor命令检查。
Linux需要标准的gcc构建工具以及libgtk3和libwebkit。而不是列出不同发行版的大量命令，Wails可以尝试确定您特定发行版的安装命令。安装后运行wails doctor，将显示如何安装依赖项。如果您的发行版/软件包管理器不受支持，请在discord上告诉我们。
运行wails3 doctor将检查您是否安装了正确的依赖项。如果没有安装，它将提供缺失的
+内容，并帮助您解决任何问题。
wails3命令？如果系统报告缺少wails3命令，请检查以下内容：
go/bin目录是否在PATH环境变量中。PATH变量。现在您已经安装了Wails，可以开始探索alpha版本。
+最好的起点是Wails存储库中的examples目录。其中包含了一些可以运行和玩耍的示例。
要运行示例，您可以简单地使用：
+ +在示例目录中。
+示例的状态在路线图中说明。
+要创建新项目，可以使用wails3 init命令。这将在当前目录中创建一个新项目。
Wails3默认使用Task作为其构建系统，尽管您可以使用自己的构
+建系统，或直接使用go build。Wails内置了任务构建系统，可以使用wails3 task运
+行。
如果查看Taskfile.yaml文件，您会看到有一些任务被定义。最重要的任务是build任
+务。这是在使用wails3 build时运行的任务。
任务文件可能不完整，并且可能会随时间变化而改变。
+要构建项目，可以使用wails3 build命令。这是wails3 task build的快捷方式。
警告
+| 操作系统 | +状态 | +
|---|---|
| Windows | +所有示例都可以运行 | +
| Mac | +大多数示例可以运行 | +
| Linux | +一些示例可以运行 | +
路线图是一个活动文档，可能会有所变动。如果您有任何建议，请提出一个问题。每个里程 +碑都会有一系列我们力争实现的目标。这些目标可能会有所变动。
+Alpha 1 是最初的发布版本。旨在收集关于新 API 的反馈，并让人们进行实验。主要目标 +是使大多数示例在所有平台上都能正常工作。
+| + | Mac | +Windows | +Linux | +
|---|---|---|---|
| binding | ++ | + | + |
| build | ++ | + | + |
| clipboard | ++ | + | + |
| context menus | ++ | + | + |
| dialogs | ++ | + | + |
| drag-n-drop | ++ | + | + |
| events | ++ | + | + |
| frameless | ++ | + | + |
| keybindings | ++ | + | + |
| plain | ++ | + | + |
| screen | ++ | + | + |
| systray | ++ | + | + |
| video | ++ | + | + |
| window | ++ | + | + |
| wml | ++ | + | + |
+[CATransaction synchronize] called within transaction 警
+ 告wails init 创建项目!!! note v3版本中将包含的功能可能会有所更改。
+现在可以创建多个窗口，并对每个窗口进行独立配置。
+package main
+
+import (
+ _ "embed"
+ "log"
+
+ "github.com/wailsapp/wails/v3/pkg/application"
+)
+
+//go:embed assets/*
+var assets embed.FS
+
+func main() {
+
+ app := application.New(application.Options{
+ Name: "多窗口演示",
+ Assets: application.AssetOptions{
+ FS: assets,
+ },
+ })
+
+ window1 := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Title: "窗口1",
+ })
+
+ window2 := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Title: "窗口2",
+ })
+
+ // 从embed.FS加载嵌入的html
+ window1.SetURL("/")
+ window1.Center()
+
+ // 加载外部URL
+ window2.SetURL("https://wails.app")
+
+ err := app.Run()
+
+ if err != nil {
+ log.Fatal(err.Error())
+ }
+}
+系统托盘允许您在桌面的系统托盘区域添加一个图标，并具有以下功能：
+package main
+
+import (
+ _ "embed"
+ "log"
+ "runtime"
+
+ "github.com/wailsapp/wails/v3/pkg/application"
+ "github.com/wailsapp/wails/v3/pkg/icons"
+)
+
+func main() {
+ app := application.New(application.Options{
+ Name: "系统托盘演示",
+ Mac: application.MacOptions{
+ ActivationPolicy: application.ActivationPolicyAccessory,
+ },
+ })
+
+ window := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Width: 500,
+ Height: 800,
+ Frameless: true,
+ AlwaysOnTop: true,
+ Hidden: true,
+ Windows: application.WindowsWindow{
+ HiddenOnTaskbar: true,
+ },
+ })
+
+ systemTray := app.NewSystemTray()
+
+ // macOS上的模板图标支持
+ if runtime.GOOS == "darwin" {
+ systemTray.SetTemplateIcon(icons.SystrayMacTemplate)
+ } else {
+ // 亮/暗模式图标支持
+ systemTray.SetDarkModeIcon(icons.SystrayDark)
+ systemTray.SetIcon(icons.SystrayLight)
+ }
+
+ // 菜单支持
+ myMenu := app.NewMenu()
+ myMenu.Add("Hello World!").OnClick(func(_ *application.Context) {
+ println("Hello World!")
+ })
+ systemTray.SetMenu(myMenu)
+
+ // 这将使窗口居中于系统托盘图标，偏移量为5px
+ // 单击系统托盘图标时，它将自动显示
+ // 当窗口失去焦点时隐藏
+ systemTray.AttachWindow(window).WindowOffset(5)
+
+ err := app.Run()
+ if err != nil {
+ log.Fatal(err)
+ }
+}
+插件允许您扩展Wails系统的功能。不仅可以在Go中使用插件方法，还可以从Javascript中 +调用插件方法。包含的插件有：
+v3使用新的静态分析器生成绑定。这使得生成绑定非常快速，并保留了绑定中的注释和参数 +名称。默认情况下，绑定使用ID而不是字符串进行调用。这提供了性能提升，并允许使用混 +淆工具，如garble。
+通过在项目目录中运行 wails3 generate bindings 来生成绑定。
// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+import { main } from "./models";
+
+window.go = window.go || {};
+window.go.main = {
+ GreetService: {
+ /**
+ * GreetService.Greet
+ * Greet greets a person
+ * @param name {string}
+ * @returns {Promise<string>}
+ **/
+ Greet: function (name) {
+ wails.CallByID(1411160069, ...Array.prototype.slice.call(arguments, 0));
+ },
+
+ /**
+ * GreetService.GreetPerson
+ * GreetPerson greets a person
+ * @param person {main.Person}
+ * @returns {Promise<string>}
+ **/
+ GreetPerson: function (person) {
+ wails.CallByID(4021313248, ...Array.prototype.slice.call(arguments, 0));
+ },
+ },
+};
+在v2中，构建系统完全不透明且难以自定义。在v3中，可以使用标准的Go工具构建所有内 +容。
+v2构建系统完成的所有繁重工作，例如图标生成，已作为CLI中的工具命令添加。我们 +将Taskfile整合到CLI中，以协调这些调用，以带来与v2相同的 +开发人员体验。然而，这种方法在灵活性和易用性之间达到了最佳平衡，因为现在您可以根 +据需要自定义构建过程。
+您甚至可以使用make，如果那是您的菜！
+build:darwin:
+ summary: 构建应用程序
+ platforms:
+ - darwin
+ cmds:
+ - task: pre-build
+ - task: build-frontend
+ - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}}
+ - task: post-build
+ env:
+ CGO_CFLAGS: "-mmacosx-version-min=10.13"
+ CGO_LDFLAGS: "-mmacosx-version-min=10.13"
+ MACOSX_DEPLOYMENT_TARGET: "10.13"
+现在为许多运行时操作发出事件，允许您挂钩应用程序/系统事件。在存在常见平台事件的 +地方，还发出了跨平台（通用）事件，允许您在跨平台上编写相同的事件处理方法。
+还可以注册事件钩子。这些钩子类似于On方法，但是是同步的，并允许您取消事件。例
+如，在关闭窗口之前显示确认对话框的示例。
package main
+
+import (
+ _ "embed"
+ "log"
+ "time"
+
+ "github.com/wailsapp/wails/v3/pkg/application"
+ "github.com/wailsapp/wails/v3/pkg/events"
+)
+
+//go:embed assets
+var assets embed.FS
+
+func main() {
+
+ app := application.New(application.Options{
+ Name: "Events Demo",
+ Description: "Events API演示",
+ Assets: application.AssetOptions{
+ FS: assets,
+ },
+ Mac: application.MacOptions{
+ ApplicationShouldTerminateAfterLastWindowClosed: true,
+ },
+ })
+
+ // 自定义事件处理
+ app.Events.On("myevent", func(e *application.WailsEvent) {
+ log.Printf("[Go] 收到WailsEvent事件: %+v\n", e)
+ })
+
+ // 特定于操作系统的应用程序事件
+ app.On(events.Mac.ApplicationDidFinishLaunching, func(event *application.Event) {
+ println("events.Mac.ApplicationDidFinishLaunching触发！")
+ })
+
+ // 平台无关事件
+ app.On(events.Common.ApplicationStarted, func(event *application.Event) {
+ println("events.Common.ApplicationStarted触发！")
+ })
+
+ win1 := app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+ Title: "关闭我需要3次确认！",
+ })
+
+ var countdown = 3
+
+ // 注册钩子以取消窗口关闭
+ win1.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) {
+ countdown--
+ if countdown == 0 {
+ println("关闭！")
+ return
+ }
+ println("不行！不关闭！")
+ e.Cancel()
+ })
+
+ win1.On(events.Common.WindowFocus, func(e *application.WindowEvent) {
+ println("[事件] 窗口焦点！")
+ })
+
+ err := app.Run()
+
+ if err != nil {
+ log.Fatal(err.Error())
+ }
+}
+一种实验性的功能，使用纯HTML调用运行时方法，类似于htmx。
+<!doctype html>
+<html lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <title>Wails ML演示</title>
+ </head>
+ <body style="margin-top:50px; color: white; background-color: #191919">
+ <h2>Wails ML演示</h2>
+ <p>此应用程序不包含任何Javascript！</p>
+ <button wml-event="button-pressed">按我！</button>
+ <button wml-event="delete-things" wml-confirm="确定吗？">
+ 删除所有内容！
+ </button>
+ <button wml-window="Close" wml-confirm="确定吗？">关闭窗口？</button>
+ <button wml-window="Center">居中</button>
+ <button wml-window="Minimise">最小化</button>
+ <button wml-window="Maximise">最大化</button>
+ <button wml-window="UnMaximise">取消最大化</button>
+ <button wml-window="Fullscreen">全屏</button>
+ <button wml-window="UnFullscreen">取消全屏</button>
+ <button wml-window="Restore">还原</button>
+ <div
+ style="width: 200px; height: 200px; border: 2px solid white;"
+ wml-event="hover"
+ wml-trigger="mouseover"
+ >
+ 悬停在我上面
+ </div>
+ </body>
+</html>
+