diff --git a/website/docs/gettingstarted/installation.mdx b/website/docs/gettingstarted/installation.mdx index 3b4cd33cc..7358a3ecd 100644 --- a/website/docs/gettingstarted/installation.mdx +++ b/website/docs/gettingstarted/installation.mdx @@ -20,9 +20,9 @@ Wails has a number of common dependencies that are required before installation: ### Go -Download Go from the [Go Downloads Page](https://golang.org/dl/). +Download Go from the [Go Downloads Page](https://go.dev/doc/install). -Ensure that you follow the official [Go installation instructions](https://golang.org/doc/install.mdx#install). 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: +Ensure that you follow the official [Go installation instructions](https://go.dev/doc/install). 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: - Check Go is installed correctly: `go version` - Check "~/go/bin" is in your PATH variable: `echo $PATH | grep go/bin` @@ -37,6 +37,7 @@ Run `npm --version` to verify. You will also need to install platform specific dependencies: + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -76,3 +77,10 @@ Run `go install github.com/wailsapp/wails/v2/cmd/wails@latest` to install the Wa ## System Check Running `wails 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. + +## The `wails` command appears to be missing? + +If your system is reporting that the `wails` command is missing, make sure you have followed the Go installation guide +correctly. Normally, it means that the `go/bin` directory in your User's home directory is not in the `PATH` environment +variable. You will also normally need to close and reopen any open command prompts so that changes to the environment +made by the installer are reflected at the command prompt. \ No newline at end of file diff --git a/website/docs/guides/application-development.mdx b/website/docs/guides/application-development.mdx index 039cb227d..d9de25d2e 100644 --- a/website/docs/guides/application-development.mdx +++ b/website/docs/guides/application-development.mdx @@ -113,6 +113,40 @@ func main() { This will bind all public methods in our `App` struct (it will never bind the startup and shutdown methods). +### Dealing with context when binding multiple structs + +If you want to bind methods for multiple structs but want each struct to keep a reference to the context so that you +can use the runtime functions, a good pattern is to pass the context from the `OnStartup` method to your struct instances +: + +```go +func main() { + + app := NewApp() + otherStruct := NewOtherStruct() + + err := wails.Run(&options.App{ + Title: "My App", + Width: 800, + Height: 600, + OnStartup: func(ctx context.Context){ + app.SetContext(ctx) + otherStruct.SetContext(ctx) + }, + OnShutdown: app.shutdown, + Bind: []interface{}{ + app, + otherStruct + }, + }) + if err != nil { + log.Fatal(err) + } +} +``` + + + More information on Binding can be found [here](../howdoesitwork.mdx#method-binding). ## Application Menu diff --git a/website/docs/guides/troubleshooting.mdx b/website/docs/guides/troubleshooting.mdx index b355f2389..9c7898eb3 100644 --- a/website/docs/guides/troubleshooting.mdx +++ b/website/docs/guides/troubleshooting.mdx @@ -1,8 +1,14 @@ - # Troubleshooting An assortment of troubleshooting tips. +## The `wails` command appears to be missing? + +If your system is reporting that the `wails` command is missing, make sure you have followed the Go installation guide +correctly. Normally, it means that the `go/bin` directory in your User's home directory is not in the `PATH` environment +variable. You will also normally need to close and reopen any open command prompts so that changes to the environment +made by the installer are reflected at the command prompt. + ## My application is displaying a white/blank screen Check that your application includes the assets from the correct directory. In your `main.go` file, you will have