From d9a5130311680b3b6de37d9e9a55ab0142f14c08 Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Mon, 25 Sep 2023 20:56:29 +1000 Subject: [PATCH] Use prettier on docs source --- mkdocs-website/README.md | 26 +- mkdocs-website/docs/API/application.md | 126 ++++--- mkdocs-website/docs/API/mainthread.md | 30 +- mkdocs-website/docs/API/menu.md | 23 +- mkdocs-website/docs/API/systray.md | 34 +- mkdocs-website/docs/API/window.md | 43 ++- mkdocs-website/docs/changelog.md | 13 +- mkdocs-website/docs/development/changes.md | 313 ++++++++++++------ .../docs/development/introduction.md | 118 ++++--- mkdocs-website/docs/development/status.md | 82 ++--- .../docs/getting-started/feedback.md | 42 +-- .../docs/getting-started/installation.md | 25 +- .../docs/getting-started/next-steps.md | 24 +- mkdocs-website/docs/whats-new.md | 158 +++++---- v3/Taskfile.yaml | 3 + 15 files changed, 651 insertions(+), 409 deletions(-) diff --git a/mkdocs-website/README.md b/mkdocs-website/README.md index 631e1c01e..f4901146a 100644 --- a/mkdocs-website/README.md +++ b/mkdocs-website/README.md @@ -2,7 +2,8 @@ This is the documentation for Wails v3. It is currently a work in progress. -If you do not wish to build it locally, it is available online at [https://wailsapp.github.io/wails/](https://wailsapp.github.io/wails/). +If you do not wish to build it locally, it is available online at +[https://wailsapp.github.io/wails/](https://wailsapp.github.io/wails/). ## Recommended Setup Steps @@ -12,16 +13,18 @@ Install the wails3 CLI if you haven't already: go install github.com/wailsapp/wails/v3/cmd/wails3@latest ``` -The documentation uses mkdocs, so you will need to install [Python](https://www.python.org/). Once installed, -you can setup the documentation by running the following command: +The documentation uses mkdocs, so you will need to install +[Python](https://www.python.org/). Once installed, you can setup the +documentation by running the following command: ```bash wails3 task docs:setup ``` -This will install the required dependencies for you. +This will install the required dependencies for you. -If you have installed the wails3 CLI, you can run the following command to build the documentation and serve it locally: +If you have installed the wails3 CLI, you can run the following command to build +the documentation and serve it locally: ```bash wails3 task docs:serve @@ -31,13 +34,12 @@ wails3 task docs:serve To install manually, you will need to do the following: - - Install [Python](https://www.python.org/) - - Run `pip install -r requirements.txt` to install the required dependencies - - Run `mkdocs serve` to serve the documentation locally - - Run `mkdocs build` to build the documentation - +- Install [Python](https://www.python.org/) +- Run `pip install -r requirements.txt` to install the required dependencies +- Run `mkdocs serve` to serve the documentation locally +- Run `mkdocs build` to build the documentation ## Contributing -If you would like to contribute to the documentation, please feel free to open a PR! - +If you would like to contribute to the documentation, please feel free to open a +PR! diff --git a/mkdocs-website/docs/API/application.md b/mkdocs-website/docs/API/application.md index 79f721e9f..2d1a3c1cf 100644 --- a/mkdocs-website/docs/API/application.md +++ b/mkdocs-website/docs/API/application.md @@ -1,17 +1,21 @@ # Application -The application API assists in creating an application using the Wails framework. +The application API assists in creating an application using the Wails +framework. ### New 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. +`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. +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. ```go title="main.go" hl_lines="6-9" package main @@ -23,14 +27,15 @@ func main() { Name: "WebviewWindow Demo", // Other options }) - + // Rest of application } ``` ### Get -`Get()` returns the global application instance. It's useful when you need to access the application from different parts of your code. +`Get()` returns the global application instance. It's useful when you need to +access the application from different parts of your code. ```go // Get the application instance @@ -41,14 +46,16 @@ func main() { 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. +`Capabilities()` retrieves a map of capabilities that the application currently +has. Capabilities can be about different features the operating system provides, +like webview features. ```go // Get the application capabilities capabilities := app.Capabilities() if capabilities.HasNativeDrag { // Do something - } + } ``` ### GetPID @@ -68,21 +75,22 @@ API: `Run() error` `Run()` starts the execution of the application and its components. ```go - app := application.New(application.Options{ - //options + app := application.New(application.Options{ + //options }) // Run the application err := application.Run() if err != nil { // Handle error - } + } ``` ### Quit API: `Quit()` -`Quit()` quits the application by destroying windows and potentially other components. +`Quit()` quits the application by destroying windows and potentially other +components. ```go // Quit the application @@ -93,7 +101,8 @@ API: `Quit()` API: `IsDarkMode() bool` -`IsDarkMode()` checks if the application is running in dark mode. It returns a boolean indicating whether dark mode is enabled. +`IsDarkMode()` checks if the application is running in dark mode. It returns a +boolean indicating whether dark mode is enabled. ```go // Check if dark mode is enabled @@ -128,7 +137,8 @@ API: `Show()` API: `NewWebviewWindow() *WebviewWindow` -`NewWebviewWindow()` creates a new Webview window with default options, and returns it. +`NewWebviewWindow()` creates a new Webview window with default options, and +returns it. ```go // Create a new webview window @@ -137,9 +147,12 @@ API: `NewWebviewWindow() *WebviewWindow` ### NewWebviewWindowWithOptions -API: `NewWebviewWindowWithOptions(windowOptions WebviewWindowOptions) *WebviewWindow` +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. +`NewWebviewWindowWithOptions()` creates a new webview window with custom +options. The newly created window is added to a map of windows managed by the +application. ```go // Create a new webview window with custom options @@ -155,7 +168,8 @@ API: `NewWebviewWindowWithOptions(windowOptions WebviewWindowOptions) *WebviewWi API: `OnWindowCreation(callback func(window *WebviewWindow))` -`OnWindowCreation()` registers a callback function to be called when a window is created. +`OnWindowCreation()` registers a callback function to be called when a window is +created. ```go // Register a callback to be called when a window is created @@ -179,7 +193,8 @@ API: `GetWindowByName(name string) *WebviewWindow` 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. +`CurrentWindow()` fetches and returns a pointer to the currently active window +in the application. If there is no window, it returns nil. ```go // Get the current window @@ -190,7 +205,8 @@ API: `CurrentWindow() *WebviewWindow` API: `RegisterContextMenu(name string, menu *Menu)` -`RegisterContextMenu()` registers a context menu with a given name. This menu can be used later in the application. +`RegisterContextMenu()` registers a context menu with a given name. This menu +can be used later in the application. ```go @@ -205,7 +221,9 @@ API: `RegisterContextMenu(name string, menu *Menu)` 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. +`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. ```go // Create a new menu @@ -219,7 +237,8 @@ API: `SetMenu(menu *Menu)` API: `ShowAboutDialog()` -`ShowAboutDialog()` shows an "About" dialog box. It can show the application's name, description and icon. +`ShowAboutDialog()` shows an "About" dialog box. It can show the application's +name, description and icon. ```go // Show the about dialog @@ -228,59 +247,76 @@ API: `ShowAboutDialog()` ### Info -API: `InfoDialog()` +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. +`InfoDialog()` creates and returns a new instance of `MessageDialog` with an +`InfoDialogType`. This dialog is typically used to display informational +messages to the user. ### Question -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: `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. ### Warning -API: `WarningDialog()` +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. +`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. ### Error -API: `ErrorDialog()` +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. +`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. ### OpenFile -API: `OpenFileDialog()` +API: `OpenFileDialog()` -`OpenFileDialog()` creates and returns a new `OpenFileDialogStruct`. This dialog prompts the user to select one or more files from their file system. +`OpenFileDialog()` creates and returns a new `OpenFileDialogStruct`. This dialog +prompts the user to select one or more files from their file system. ### SaveFile -API: `SaveFileDialog()` +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. +`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. ### OpenDirectory -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: `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. ### On -API: `On(eventType events.ApplicationEventType, callback func(event *Event)) func()` +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. +`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. ### RegisterHook -API: `RegisterHook(eventType events.ApplicationEventType, callback func(event *Event)) func()` +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. +`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. ### GetPrimaryScreen @@ -294,7 +330,9 @@ 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. +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. ## Options @@ -318,4 +356,4 @@ This is a brief summary of the exported methods in the provided `App` struct. Do --8<-- ../v3/pkg/application/options_application_mac.go --8<-- -``` \ No newline at end of file +``` diff --git a/mkdocs-website/docs/API/mainthread.md b/mkdocs-website/docs/API/mainthread.md index d62f0c425..0a22da5bb 100644 --- a/mkdocs-website/docs/API/mainthread.md +++ b/mkdocs-website/docs/API/mainthread.md @@ -1,38 +1,50 @@ # Main Thread Functions -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. +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. ### InvokeSync 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. +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. ### InvokeSyncWithResult 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. +This function works similarly to `InvokeSync(fn func())`, however, it yields a +result. Use this for calling any function with a single return. ### InvokeSyncWithError 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. +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. ### InvokeSyncWithResultAndError -API: `InvokeSyncWithResultAndError[T any](fn func() (T, error)) (res T, err error)` +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. +This function runs `fn` synchronously and returns both a result of type `T` and +an error. ### InvokeAsync 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. +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. \ No newline at end of file +_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. diff --git a/mkdocs-website/docs/API/menu.md b/mkdocs-website/docs/API/menu.md index c4b8b4d49..fe28116bd 100644 --- a/mkdocs-website/docs/API/menu.md +++ b/mkdocs-website/docs/API/menu.md @@ -1,6 +1,7 @@ # Menu -Menus can be created and added to the application. They can be used to create context menus, system tray menus and application menus. +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: @@ -15,7 +16,8 @@ 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. +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. ### AddSeparator @@ -27,31 +29,38 @@ 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. +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. ### AddRadio 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. +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. ### Update API: `Update()` -This method processes any radio groups and updates the menu if a menu implementation is not initialized. +This method processes any radio groups and updates the menu if a menu +implementation is not initialized. ### AddSubmenu 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. +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. ### AddRole 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`. +This method takes `role` of type `Role` as input, adds it to the menu if it is +not `nil` and returns the `Menu`. ### SetLabel diff --git a/mkdocs-website/docs/API/systray.md b/mkdocs-website/docs/API/systray.md index 66090e16b..30f15dc47 100644 --- a/mkdocs-website/docs/API/systray.md +++ b/mkdocs-website/docs/API/systray.md @@ -1,6 +1,8 @@ # System Tray -The system tray houses notification area on a desktop environment, which can contain both icons of currently-running applications and specific system notifications. +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()`: @@ -15,19 +17,20 @@ The following methods are available on the `SystemTray` type: API: `SetLabel(label string)` -The `SetLabel` method sets the tray's label. +The `SetLabel` method sets the tray's label. ### Label API: `Label() string` -The `Label` method retrieves the tray's label. +The `Label` method retrieves the tray's label. ### PositionWindow API: `PositionWindow(*WebviewWindow, offset int) error` -The `PositionWindow` method calls both `AttachWindow` and `WindowOffset` methods. +The `PositionWindow` method calls both `AttachWindow` and `WindowOffset` +methods. ### SetIcon @@ -39,13 +42,13 @@ 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. +The `SetDarkModeIcon` method sets the system tray's icon when in dark mode. ### SetMenu API: `SetMenu(menu *Menu) *SystemTray` -The `SetMenu` method sets the system tray's menu. +The `SetMenu` method sets the system tray's menu. ### Destroy @@ -63,37 +66,44 @@ 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. +The `OnRightClick` method sets the function to execute when right-clicking the +tray icon. ### OnDoubleClick API: `OnDoubleClick(handler func()) *SystemTray` -The `OnDoubleClick` method sets the function to execute when double-clicking the tray icon. +The `OnDoubleClick` method sets the function to execute when double-clicking the +tray icon. ### OnRightDoubleClick API: `OnRightDoubleClick(handler func()) *SystemTray` -The `OnRightDoubleClick` method sets the function to execute when right double-clicking the tray icon. +The `OnRightDoubleClick` method sets the function to execute when right +double-clicking the tray icon. ### AttachWindow 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. +The `AttachWindow` method attaches a window to the system tray. The window will +be shown when the system tray icon is clicked. ### WindowOffset API: `WindowOffset(offset int) *SystemTray` -The `WindowOffset` method sets the gap in pixels between the system tray and the window. +The `WindowOffset` method sets the gap in pixels between the system tray and the +window. ### WindowDebounce 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. +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. ### OpenMenu diff --git a/mkdocs-website/docs/API/window.md b/mkdocs-website/docs/API/window.md index 99b7180a5..aa73ec91a 100644 --- a/mkdocs-website/docs/API/window.md +++ b/mkdocs-website/docs/API/window.md @@ -1,6 +1,10 @@ # Window -To create a window, use [Application.NewWebviewWindow](application.md#newwebviewwindow) or [Application.NewWebviewWindowWithOptions](application.md#newwebviewwindowwithoptions). The former creates a window with default options, while the latter allows you to specify custom options. +To create a window, use +[Application.NewWebviewWindow](application.md#newwebviewwindow) or +[Application.NewWebviewWindowWithOptions](application.md#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: @@ -8,8 +12,8 @@ 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. - +This method updates the window title to the provided string. It returns the +WebviewWindow object, allowing for method chaining. ### Name @@ -17,13 +21,13 @@ API: `Name() string` This function returns the name of the WebviewWindow. - ### SetSize 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. - +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. ### SetAlwaysOnTop @@ -31,20 +35,19 @@ API: `SetAlwaysOnTop(b bool) *WebviewWindow` This function sets the window to stay on top based on the boolean flag provided. - ### Show 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. - +`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. ### Hide 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. - +`Hide` method is used to hide the window. It sets the hidden status of the +window to true and emits the window hide event. ### SetURL @@ -52,13 +55,12 @@ API: `SetURL(s string) *WebviewWindow` `SetURL` method is used to set the URL of the window to the given URL string. - ### SetZoom API: `SetZoom(magnification float64) *WebviewWindow` -`SetZoom` method sets the zoom level of the window content to the provided magnification level. - +`SetZoom` method sets the zoom level of the window content to the provided +magnification level. ### GetZoom @@ -66,7 +68,6 @@ API: `GetZoom() float64` `GetZoom` function returns the current zoom level of the window content. - ### GetScreen API: `GetScreen() (*Screen, error)` @@ -77,8 +78,9 @@ API: `GetScreen() (*Screen, error)` 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). - +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). #### RegisterContextMenu @@ -86,27 +88,24 @@ API: `RegisterContextMenu(name string, menu *Menu)` This function is used to register a context menu and assigns it the given name. - #### NativeWindowHandle API: `NativeWindowHandle() (uintptr, error)` This function is used to fetch the platform native window handle for the window. - #### Focus API: `Focus()` This function is used to focus the window. - #### SetEnabled API: `SetEnabled(enabled bool)` -This function is used to enable/disable the window based on the provided boolean value. - +This function is used to enable/disable the window based on the provided boolean +value. #### SetAbsolutePosition diff --git a/mkdocs-website/docs/changelog.md b/mkdocs-website/docs/changelog.md index 46245fbcf..fa53f4f25 100644 --- a/mkdocs-website/docs/changelog.md +++ b/mkdocs-website/docs/changelog.md @@ -17,14 +17,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] - ### Added -* [darwin] add getPrimaryScreen/getScreens to impl by @tmclane in https://github.com/wailsapp/wails/pull/2618 + +- [darwin] add getPrimaryScreen/getScreens to impl by @tmclane in + https://github.com/wailsapp/wails/pull/2618 ### Fixed -- Fixed background colours of examples on Windows by [mmgvh](https://github.com/mmghv) in [#2750](https://github.com/wailsapp/wails/pull/2750). -- Fixed default context menus by [mmgvh](https://github.com/mmghv) in [#2753](https://github.com/wailsapp/wails/pull/2753). +- Fixed background colours of examples on Windows by + [mmgvh](https://github.com/mmghv) in + [#2750](https://github.com/wailsapp/wails/pull/2750). +- Fixed default context menus by [mmgvh](https://github.com/mmghv) in + [#2753](https://github.com/wailsapp/wails/pull/2753). ### Changed @@ -33,4 +37,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Deprecated ### Security - diff --git a/mkdocs-website/docs/development/changes.md b/mkdocs-website/docs/development/changes.md index 8fa9978a0..d5bbfd741 100644 --- a/mkdocs-website/docs/development/changes.md +++ b/mkdocs-website/docs/development/changes.md @@ -1,11 +1,11 @@ # Changes for v3 -!!! note - This is currently an unsorted brain dump of changes. It will be organised into a more readable format soon. +!!! note This is currently an unsorted brain dump of changes. It will be +organised into a more readable format soon. ## Options -The application options have been revised since v2. +The application options have been revised since v2. ## Events @@ -17,97 +17,139 @@ In v3, there are 3 types of events: ### Application Events -Application events are events that are emitted by the application. These events include native events such as `ApplicationDidFinishLaunching` on macOS. +Application events are events that are emitted by the application. These events +include native events such as `ApplicationDidFinishLaunching` on macOS. ### Window Events -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`. +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`. ### Custom Events -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. +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. +The data associated with a WailsEvent is now a single value. If multiple values +are required, then a struct can be used. ### Event callbacks and `Emit` function signature -The 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. +The 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. +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 `OffAll` -In 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. +In 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. ### Hooks -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. +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 -Logging in v2 was confusing as both application logs and system (internal) logs were using the same logger. We have simplified this as follows: - -- Internal logs are now handled using the standard Go `slog` logger. This is configured using the `logger` option in the application options. By default, this uses the [tint](https://github.com/lmittmann/tint) logger. -- Application logs can now be achieved through the new `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. +Logging in v2 was confusing as both application logs and system (internal) logs +were using the same logger. We have simplified this as follows: +- Internal logs are now handled using the standard Go `slog` logger. This is + configured using the `logger` option in the application options. By default, + this uses the [tint](https://github.com/lmittmann/tint) logger. +- Application logs can now be achieved through the new `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. ### Developer notes -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. +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. ## 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: -- Windows now have a Name that identifies them. This is used to identify the window when emitting events. -- Windows have even more methods on the that were previously unavailable, such as `AbsolutePosition` and `ToggleDevTools`. -- Windows can now accept files via native drag and drop. See the Drag and Drop section for more details. +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: + +- Windows now have a Name that identifies them. This is used to identify the + window when emitting events. +- Windows have even more methods on the that were previously unavailable, such + as `AbsolutePosition` and `ToggleDevTools`. +- Windows can now accept files via native drag and drop. See the Drag and Drop + section for more details. ## ClipBoard -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. +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 -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: +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: ```javascript // @ts-check // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL // This file is automatically generated. DO NOT EDIT -import {main} from './models'; +import { main } from "./models"; window.go = window.go || {}; window.go.main = { - GreetService: { - - /** - * GreetService.Greet - * Greet greets a person - * @param name {string} - * @returns {Promise} - **/ - Greet: function(name) { wails.CallByID(1411160069, ...Array.prototype.slice.call(arguments, 0)); }, - - /** - * GreetService.GreetPerson - * GreetPerson greets a person - * @param person {main.Person} - * @returns {Promise} - **/ - GreetPerson: function(person) { wails.CallByID(4021313248, ...Array.prototype.slice.call(arguments, 0)); }, + GreetService: { + /** + * GreetService.Greet + * Greet greets a person + * @param name {string} + * @returns {Promise} + **/ + Greet: function (name) { + wails.CallByID(1411160069, ...Array.prototype.slice.call(arguments, 0)); }, + + /** + * GreetService.GreetPerson + * GreetPerson greets a person + * @param person {main.Person} + * @returns {Promise} + **/ + 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](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function). 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. +Bound methods are obfuscated by default, and are identified using uint32 IDs, +calculated using the +[FNV hashing algorithm](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function). +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: @@ -133,10 +175,12 @@ We can now call using this alias in the frontend: `wails.Call(1, "world!")`. ### Insecure calls -If you don't mind your calls being available in plain text in your binary and have no intention of using [garble](https://github.com/burrowers/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. +If you don't mind your calls being available in plain text in your binary and +have no intention of using [garble](https://github.com/burrowers/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!") ``` @@ -144,16 +188,19 @@ Example: !!! danger This is only provided as a convenience method for development. It is not recommended to use this in production. - ## Dialogs -Dialogs are now available in JavaScript! +Dialogs are now available in JavaScript! ### Windows -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 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: + ```go dialog := app.QuestionDialog(). SetTitle("Update"). @@ -170,40 +217,66 @@ Example: Create a button with the label `Ok` and use `OnClick()` to set the call ## Drag and Drop -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. +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 -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. +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. +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`. +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`. ## Wails Markup Language (WML) -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 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-event` +### `data-wml-event` -This 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. +This 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: + ```html ``` -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. + +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: + ```html - + ``` ### `data-wml-window` -Any `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. +Any `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. ```html @@ -211,23 +284,28 @@ Any `wails.window` method can be called by adding the `data-wml-window` attribut ### `data-wml-trigger` -This attribute specifies which javascript event should trigger the action. The default is `click`. +This attribute specifies which javascript event should trigger the action. The +default is `click`. ```html - + ``` - ## Systray -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: +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: - Clicking the systray icon with toggle the window visibility - Right-clicking the systray will open the menu, if there is one -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. +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 @@ -241,25 +319,28 @@ Plugins are standard Go structure that adhere to the following interface: type Plugin interface { Name() string Init(*application.App) error - Shutdown() + Shutdown() CallableByJS() []string InjectJS() string } ``` -The `Name()` method returns the name of the plugin. This is used for logging purposes. +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 `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 `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 `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. ### Tips @@ -277,7 +358,8 @@ const ( ) ``` -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: +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: ```go type MyEnum = float64 @@ -293,67 +375,80 @@ In Javascript, you can then use the following: ```js const MyEnum = { - MyEnumOne: 0, - MyEnumTwo: 1, - MyEnumThree: 2 -} + MyEnumOne: 0, + MyEnumTwo: 1, + MyEnumThree: 2, +}; ``` -- Why use `float64`? Can't we use `int`? - - Because JavaScript doesn't have a concept of `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. +- Why use `float64`? Can't we use `int`? + - Because JavaScript doesn't have a concept of `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. ### BackgroundColour -In v2, this was a pointer to an `RGBA` struct. In v3, this is an `RGBA` struct value. +In v2, this was a pointer to an `RGBA` struct. In v3, this is an `RGBA` struct +value. ### WindowIsTranslucent -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: +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 background - `BackgroundTypeTransparent` - The window will have a transparent background - `BackgroundTypeTranslucent` - The window will have a translucent background -On 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: +On 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 system - `None` - The window will have no background - `Mica` - The window will use the Mica effect - `Acrylic` - The window will use the acrylic effect - `Tabbed` - The window will use the tabbed effect - ## Windows Application Options ### WndProcInterceptor -If 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: +If 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: ```go func(hwnd uintptr, msg uint32, wParam, lParam uintptr) (returnValue uintptr, shouldReturn) ``` -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 +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. ## Hide Window on Close + OnBeforeClose -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, 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. ## Window Drag -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: +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 window - `no-drag` - The element cannot be used to drag the window -We would have ideally liked to use `app-region`, however this is not supported by the `getComputedStyle` call on -webkit on macOS. - +We would have ideally liked to use `app-region`, however this is not supported +by the `getComputedStyle` call on webkit on macOS. diff --git a/mkdocs-website/docs/development/introduction.md b/mkdocs-website/docs/development/introduction.md index 6a2d6ca16..10b6d8d1e 100644 --- a/mkdocs-website/docs/development/introduction.md +++ b/mkdocs-website/docs/development/introduction.md @@ -1,32 +1,35 @@ # Introduction -!!! note - This guide is a work in progress. +!!! 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. +Thanks for wanting to help out with development of Wails! This guide will help +you get started. ## Getting Started - Git clone this repository. Checkout the `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](https://nodejs.org/en/download). +- Optional: If you are wanting to use the build system to build frontend code, + you will need to install [npm](https://nodejs.org/en/download). ## Building -For simple programs, you can use the standard `go build` command. It's also possible to use `go run`. +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](https://taskfile.dev) build system. -For more information, check out the task homepage or run `wails task --help`. +Wails also comes with a build system that can be used to build more complex +projects. It utilises the awesome [Task](https://taskfile.dev) build system. For +more information, check out the task homepage or run `wails task --help`. ## Project layout The project has the following structure: - + ``` v3 ├── cmd/wails3 // CLI - ├── examples // Examples of Wails apps + ├── examples // Examples of Wails apps ├── internal // Internal packages | ├── runtime // The Wails JS runtime | └── templates // The supported project templates @@ -44,18 +47,27 @@ The project has the following structure: ### Adding window functionality -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. +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. - Mac: `webview_window_darwin.go` - Windows: `webview_window_windows.go` - Linux: `webview_window_linux.go` -Most, 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`. +Most, 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`. ### Updating the runtime -The runtime is located in `v3/internal/runtime`. When the runtime is updated, the following steps need to be taken: +The runtime is located in `v3/internal/runtime`. When the runtime is updated, +the following steps need to be taken: ```shell wails3 task runtime:build @@ -63,14 +75,19 @@ wails3 task runtime:build ### Events -Events are defined in `v3/pkg/events`. When adding a new event, 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: - Add the event to the `events.txt` file - Run `wails3 task events:generate` -There 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. +There 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`: +When adding a common event, ensure that the platform specific events are mapped. +An example of this is in `window_webview_darwin.go`: ```go // Translate ShouldClose to common WindowClosing event @@ -79,7 +96,8 @@ When adding a common event, ensure that the platform specific events are mapped. }) ``` -NOTE: We may try to automate this in the future by adding the mapping to the event definition. +NOTE: We may try to automate this in the future by adding the mapping to the +event definition. ### Plugins @@ -93,35 +111,39 @@ Plugins are standard Go structure that adhere to the following interface: type Plugin interface { Name() string Init(*application.App) error - Shutdown() + Shutdown() CallableByJS() []string InjectJS() string } ``` -The `Name()` method returns the name of the plugin. This is used for logging purposes. +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 `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 `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. ## Misc Tasks ### Upgrading Taskfile -The Wails CLI uses the [Task](https://taskfile.dev) 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`. +The Wails CLI uses the [Task](https://taskfile.dev) 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 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: @@ -129,11 +151,15 @@ To upgrade the version of Taskfile used, run: wails3 task taskfile:upgrade ``` -If there are incompatibilities then they should appear in the `v3/internal/commands/task.go` file. +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. +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: +To check all changes have worked correctly, re-install the CLI and check the +version again: ```shell wails3 task cli:install @@ -142,18 +168,21 @@ wails3 task -version ## Opening a PR -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 `v3` directory. - +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 `v3` directory. ## Misc Tasks ### Upgrading Taskfile -The Wails CLI uses the [Task](https://taskfile.dev) 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`. +The Wails CLI uses the [Task](https://taskfile.dev) 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 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: @@ -161,14 +190,17 @@ To upgrade the version of Taskfile used, run: wails3 task taskfile:upgrade ``` -If there are incompatibilities then they should appear in the `v3/internal/commands/task.go` file. +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. +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: +To check all changes have worked correctly, re-install the CLI and check the +version again: ```shell wails3 task cli:install wails3 task -version ``` - diff --git a/mkdocs-website/docs/development/status.md b/mkdocs-website/docs/development/status.md index 18f38cdf7..7d467b05e 100644 --- a/mkdocs-website/docs/development/status.md +++ b/mkdocs-website/docs/development/status.md @@ -16,10 +16,10 @@ Status of features in v3. Application interface methods | Method | Windows | Linux | Mac | Notes | -|---------------------------------------------------------------|---------|-------|-----|-------| +| ------------------------------------------------------------- | ------- | ----- | --- | ----- | | run() error | Y | Y | Y | | | destroy() | | Y | Y | | -| setApplicationMenu(menu *Menu) | Y | 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 | | @@ -28,15 +28,15 @@ Application interface methods | dispatchOnMainThread(fn func()) | Y | Y | Y | | | hide() | Y | Y | Y | | | show() | Y | Y | Y | | -| getPrimaryScreen() (*Screen, error) | | Y | Y | | -| getScreens() ([]*Screen, error) | | Y | Y | | +| getPrimaryScreen() (\*Screen, error) | | Y | Y | | +| getScreens() ([]\*Screen, error) | | Y | Y | | ## Webview Window Webview Window Interface Methods | Method | Windows | Linux | Mac | Notes | -|----------------------------------------------------|---------|-------|-----|------------------------------------------| +| -------------------------------------------------- | ------- | ----- | --- | ---------------------------------------- | | center() | Y | Y | Y | | | close() | y | Y | Y | | | destroy() | | Y | Y | | @@ -44,7 +44,7 @@ Webview Window Interface Methods | focus() | Y | Y | | | | forceReload() | | Y | Y | | | fullscreen() | Y | Y | Y | | -| getScreen() (*Screen, error) | y | Y | Y | | +| getScreen() (\*Screen, error) | y | Y | Y | | | getZoom() float64 | | Y | Y | | | height() int | Y | Y | Y | | | hide() | Y | Y | Y | | @@ -90,7 +90,7 @@ Webview Window Interface Methods ### Application | Feature | Windows | Linux | Mac | Notes | -|---------|---------|-------|-----|-------| +| ------- | ------- | ----- | --- | ----- | | Quit | Y | Y | Y | | | Hide | Y | | Y | | | Show | Y | | Y | | @@ -98,7 +98,7 @@ Webview Window Interface Methods ### Dialogs | Feature | Windows | Linux | Mac | Notes | -|----------|---------|-------|-----|-------| +| -------- | ------- | ----- | --- | ----- | | Info | Y | Y | Y | | | Warning | Y | Y | Y | | | Error | Y | Y | Y | | @@ -109,30 +109,32 @@ Webview Window Interface Methods ### Clipboard | Feature | Windows | Linux | Mac | Notes | -|---------|---------|-------|-----|-------| +| ------- | ------- | ----- | --- | ----- | | SetText | Y | | Y | | | Text | Y | | Y | | ### ContextMenu | Feature | Windows | Linux | Mac | Notes | -|------------------|---------|-------|-----|-------| +| ---------------- | ------- | ----- | --- | ----- | | OpenContextMenu | Y | | Y | | | On By Default | | | | | | Control via HTML | Y | | | | -The default context menu is enabled by default for all elements that are `contentEditable: true`, `` -or `