[v2] Docs update

website/docs/reference/runtime/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Runtime",
+  "position": 1
+}

website/docs/reference/runtime/browser.mdx

@@ -0,0 +1,20 @@
+---
+sidebar_position: 7
+---
+
+# Browser
+
+## Overview
+
+These methods are related to the system browser.
+
+### BrowserOpenURL
+Go Signature: `BrowserOpenURL(ctx context.Context, url string)`
+
+JS Signature: `BrowserOpenURL(url string)`
+
+Opens the given URL in the system browser.
+
+
+
+

website/docs/reference/runtime/dialog.mdx

@@ -0,0 +1,140 @@
+---
+sidebar_position: 5
+---
+
+# Dialog
+
+## Overview
+
+This part of the runtime provides access to native dialogs, such as File Selectors and Message boxes.Context
+
+:::info Javascript
+  Dialog is currently unsupported in the JS runtime.
+:::
+
+### OpenDirectoryDialog
+Go Signature: `OpenDirectoryDialog(ctx context.Context, dialogOptions OpenDialogOptions) (string, error)`
+
+Returns: Selected directory (blank if the user cancelled) or an error
+
+Opens a dialog that prompts the user to select a directory. Can be customised using [OpenDialogOptions](#OpenDialogOptions).
+
+### OpenFileDialog
+Go Signature: `OpenFileDialog(ctx context.Context, dialogOptions OpenDialogOptions) (string, error)`
+
+Returns: Selected file (blank if the user cancelled) or an error
+
+Opens a dialog that prompts the user to select a file. Can be customised using [OpenDialogOptions](#OpenDialogOptions).
+
+
+### OpenMultipleFilesDialog
+Go Signature: `OpenMultipleFilesDialog(ctx context.Context, dialogOptions OpenDialogOptions) ([]string, error)`
+
+Returns: Selected files (nil if the user cancelled) or an error
+
+Opens a dialog that prompts the user to select multiple files. Can be customised using [OpenDialogOptions](#OpenDialogOptions).
+
+
+### SaveFileDialog
+Go Signature: `SaveFileDialog(ctx context.Context, dialogOptions SaveDialogOptions) (string, error)`
+
+Returns: The selected file (blank if the user cancelled) or an error
+
+Opens a dialog that prompts the user to select a filename for the purposes of saving. Can be customised using [SaveDialogOptions](#SaveDialogOptions).
+
+
+### MessageDialog
+Go Signature: `MessageDialog(ctx context.Context, dialogOptions MessageDialogOptions) (string, error)`
+
+Returns: The text of the selected button or an error
+
+Displays a message using a message dialog. Can be customised using [MessageDialogOptions](#MessageDialogOptions).
+
+## Options
+
+### OpenDialogOptions
+
+```go
+type OpenDialogOptions struct {
+	DefaultDirectory           string
+	DefaultFilename            string
+	Title                      string
+	Filters                    []FileFilter
+	AllowFiles                 bool // Mac Only
+	AllowDirectories           bool // Mac Only
+	ShowHiddenFiles            bool // Mac Only
+	CanCreateDirectories       bool // Mac Only
+	ResolvesAliases            bool // Mac Only
+	TreatPackagesAsDirectories bool // Mac Only
+}
+```
+
+### SaveDialogOptions
+
+```go
+type SaveDialogOptions struct {
+	DefaultDirectory           string
+	DefaultFilename            string
+	Title                      string
+	Filters                    []FileFilter
+	ShowHiddenFiles            bool // Mac Only
+	CanCreateDirectories       bool // Mac Only
+	TreatPackagesAsDirectories bool // Mac Only
+}
+```
+
+### MessageDialogOptions
+
+```go
+type MessageDialogOptions struct {
+	Type          DialogType
+	Title         string
+	Message       string
+	Buttons       []string
+	DefaultButton string // Mac Only
+	CancelButton  string // Mac Only
+	Icon          string // Mac Only
+}
+```
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs
+  defaultValue="Windows"
+  values={[
+    {label: 'Windows', value: 'Windows'},
+    {label: 'MacOS', value: 'MacOS'},
+    {label: 'Linux', value: 'Linux'},
+  ]}>
+  <TabItem value="MacOS">
+    Both "DefaultButton" and "CancelButton" should match a value in "Buttons".
+  </TabItem>
+  <TabItem value="Windows">
+    Windows has standard dialog types and the buttons are not customisable. The
+    value returned will be one of: "Ok", "Cancel", "Abort", "Retry", "Ignore", "Yes", "No", "Try Again" or "Continue"
+  </TabItem>
+  <TabItem value="Linux">
+    Coming Soon...
+  </TabItem>
+</Tabs>
+
+#### DialogType
+
+```go
+const (
+     	InfoDialog     DialogType = "info"
+     	WarningDialog  DialogType = "warning"
+     	ErrorDialog    DialogType = "error"
+     	QuestionDialog DialogType = "question"
+     )
+```
+
+### FileFilter
+
+```go
+type FileFilter struct {
+	DisplayName string // Filter information EG: "Image Files (*.jpg, *.png)"
+	Pattern     string // semi-colon separated list of extensions, EG: "*.jpg;*.png"
+}
+```

website/docs/reference/runtime/events.mdx

@@ -0,0 +1,51 @@
+---
+sidebar_position: 2
+---
+
+# Events
+
+## Overview
+
+The Wails runtime provides a unified events system, where events can be emitted or received by either Go or Javascript.
+Optionally, data may be passed with the events. Listeners will receive the data in the local data types.
+
+### EventsOn
+
+Go Signature: `EventsOn(ctx context.Context, eventName string, callback func(optionalData ...interface{}))`
+
+JS Signature: `EventsOn(eventName string, callback function(optionalData?: any))`
+
+This method sets up a listener for the given event name. When an event of type `eventName` is [emitted](#EventsEmit),
+the callback is triggered. Any additional data sent with the emitted event will be passed to the callback.
+
+### EventsOff
+
+Go Signature: `EventsOff(ctx context.Context, eventName string)`
+
+JS Signature: `EventsOff(eventName string)`
+
+This method unregisters the listener for the given event name.
+
+### EventsOnce
+
+Go Signature: `EventsOnce(ctx context.Context, eventName string, callback func(optionalData ...interface{}))`
+
+JS Signature: `EventsOnce(eventName string, callback function(optionalData?: any))`
+
+This method sets up a listener for the given event name, but will only trigger once.
+
+### EventsOnMultiple
+
+Go Signature: `EventsOnMultiple(ctx context.Context, eventName string, callback func(optionalData ...interface{}), counter int)`
+
+JS Signature: `EventsOnMultiple(eventName string, callback function(optionalData?: any), counter int)`
+
+This method sets up a listener for the given event name, but will only trigger a maximum of `counter` times.
+
+### EventsEmit
+
+Go Signature: `Events(ctx context.Context, eventName string, optionalData ...interface{})`
+
+JS Signature: `Events(ctx context, optionalData function(optionalData?: any))`
+
+This method emits the given event. Optional data may be passed with the event. This will trigger any event listeners.

website/docs/reference/runtime/intro.mdx

@@ -0,0 +1,16 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+The runtime is a library that provides utility methods for your application. There is both a Go and Javascript runtime
+and the aim is to try and keep them at parity where possible.
+
+The Go Runtime is available through importing `github.com/wailsapp/wails/v2/pkg/runtime`. All methods in this package
+take a context as the first parameter. This context can be obtained from the [OnStartup](/docs/reference/options#OnStartup)
+or [OnDomReady](/docs/reference/options#OnDomReady) hooks.
+
+The Javascript library is available to the frontend via the `window.runtime` map. There is a runtime package generated when using `dev`
+mode that provides Typescript declarations for the runtime. This should be located in the `wailsjs` directory in your
+frontend directory.

website/docs/reference/runtime/log.mdx

@@ -0,0 +1,114 @@
+---
+sidebar_position: 3
+---
+
+# Log
+
+## Overview
+
+The Wails runtime provides a logging mechanism that may be called from Go or Javascript. Like most
+loggers, there are a number of log levels:
+
+  - Trace
+  - Debug
+  - Info
+  - Warning
+  - Error
+  - Fatal
+
+The logger will output any log message at the current, or higher, log level. Example: The `Debug` log
+level will output all messages except `Trace` messages.
+
+### LogPrint
+
+Go Signature: `LogPrint(ctx context.Context, message string)`
+
+JS Signature: `LogPrint(message: string)`
+
+Logs the given message as a raw message.
+
+### LogTrace
+
+Go Signature: `LogTrace(ctx context.Context, message string)`
+
+JS Signature: `LogTrace(message: string)`
+
+Logs the given message at the `Trace` log level.
+
+### LogDebug
+
+Go Signature: `LogDebug(ctx context.Context, message string)`
+
+JS Signature: `LogDebug(message: string)`
+
+Logs the given message at the `Debug` log level.
+
+
+### LogInfo
+
+Go Signature: `LogInfo(ctx context.Context, message string)`
+
+JS Signature: `LogInfo(message: string)`
+
+Logs the given message at the `Info` log level.
+
+
+### LogWarning
+
+Go Signature: `LogWarning(ctx context.Context, message string)`
+
+JS Signature: `LogWarning(message: string)`
+
+Logs the given message at the `Warning` log level.
+
+
+### LogError
+
+Go Signature: `LogError(ctx context.Context, message string)`
+
+JS Signature: `LogError(message: string)`
+
+Logs the given message at the `Error` log level.
+
+
+### LogFatal
+Go Signature: `LogFatal(ctx context.Context, message string)`
+
+JS Signature: `LogFatal(message: string)`
+
+Logs the given message at the `Fatal` log level.
+
+### LogSetLogLevel
+
+Go Signature: `LogSetLogLevel(ctx context.Context, level logger.LogLevel)`
+
+JS Signature: `LogSetLogLevel(level: number)`
+
+Sets the log level. In Javascript, the number relates to the following log levels:
+
+| Value | Log Level |
+| ----- | --------- |
+| 1     | Trace     |
+| 2     | Debug     |
+| 3     | Info      |
+| 4     | Warning   |
+| 5     | Error     |
+
+## Using a Custom Logger
+
+A custom logger may be used by providing it using the [Logger](/docs/reference/options#logger)
+application option. The only requirement is that the logger implements the `logger.Logger` interface
+defined in `github.com/wailsapp/wails/v2/pkg/logger`:
+
+```go title="logger.go"
+type Logger interface {
+	Print(message string)
+	Trace(message string)
+	Debug(message string)
+	Info(message string)
+	Warning(message string)
+	Error(message string)
+	Fatal(message string)
+}
+```
+

website/docs/reference/runtime/menu.mdx

@@ -0,0 +1,25 @@
+---
+sidebar_position: 6
+---
+
+# Menu
+
+## Overview
+
+These methods are related to the application menu.
+
+:::info Javascript
+  Menu is currently unsupported in the JS runtime.
+:::
+
+### MenuSetApplicationMenu
+Go Signature: `MenuSetApplicationMenu(ctx context.Context, menu *menu.Menu)`
+
+Sets the application menu to the given [menu](/docs/reference/menus) .
+
+### MenuUpdateApplicationMenu
+Go Signature: `MenuUpdateApplicationMenu(ctx context.Context)`
+
+Updates the application menu, picking up any changes to the menu passed to `MenuSetApplicationMenu`.
+
+

website/docs/reference/runtime/window.mdx

@@ -0,0 +1,184 @@
+---
+sidebar_position: 4
+---
+
+# Window
+
+## Overview
+
+These methods give control of the application window.
+
+### WindowSetTitle
+Go Signature: `WindowSetTitle(ctx context.Context, title string)`
+
+JS Signature: `WindowSetTitle(title: string)`
+
+Sets the text in the window title bar.
+
+### WindowFullscreen
+Go Signature: `WindowFullscreen(ctx context.Context)`
+
+JS Signature: `WindowFullscreen()`
+
+Makes the window full screen.
+
+### WindowUnFullscreen
+Go Signature: `WindowUnFullscreen(ctx context.Context)`
+
+JS Signature: `WindowUnFullscreen()`
+
+Restores the previous window dimensions and position prior to full screen.
+
+### WindowCenter
+Go Signature: `WindowCenter(ctx context.Context)`
+
+JS Signature: `WindowCenter()`
+
+Centers the window on the monitor the window is currently on.
+
+### WindowReload
+Go Signature: `WindowReload(ctx context.Context)`
+
+JS Signature: `WindowReload()`
+
+Performs a "reload" (Reloads index.html)
+
+### WindowShow
+Go Signature: `WindowShow(ctx context.Context)`
+
+JS Signature: `WindowShow()`
+
+Shows the window, if it is currently hidden.
+
+### WindowHide
+Go Signature: `WindowHide(ctx context.Context)`
+
+JS Signature: `WindowHide()`
+
+Hides the window, if it is currently visible.
+
+### WindowSetSize
+Go Signature: `WindowSetSize(ctx context.Context, width int, height int)`
+
+JS Signature: `WindowSetSize(size: Size)`
+
+Sets the width and height of the window.
+
+### WindowGetSize
+Go Signature: `WindowGetSize(ctx context.Context) (width int, height int)`
+
+JS Signature: `WindowGetSize() : Size`
+
+Gets the width and height of the window.
+
+### WindowSetMinSize
+Go Signature: `WindowSetMinSize(ctx context.Context, width int, height int)`
+
+JS Signature: `WindowSetMinSize(size: Size)`
+
+Sets the minimum window size.
+Will resize the window if the window is currently smaller than the given dimensions.
+
+Setting a size of `0,0` will disable this constraint.
+
+### WindowSetMaxSize
+Go Signature: `WindowSetMaxSize(ctx context.Context, width int, height int)`
+
+JS Signature: `WindowSetMaxSize(size: Size)`
+
+Sets the maximum window size.
+Will resize the window if the window is currently larger than the given dimensions.
+
+Setting a size of `0,0` will disable this constraint.
+
+### WindowSetPosition
+Go Signature: `WindowSetPosition(ctx context.Context, x int, y int)`
+
+JS Signature: `WindowSetPosition(position: Position)`
+
+Sets the window position relative to the monitor the window is currently on.
+
+### WindowGetPosition
+Go Signature: `WindowGetPosition(ctx context.Context) (x int, y int)`
+
+JS Signature: `WindowGetPosition() : Position`
+
+Gets the window position relative to the monitor the window is currently on.
+
+### WindowMaximise
+Go Signature: `WindowMaximise(ctx context.Context)`
+
+JS Signature: `WindowMaximise()`
+
+Maximises the window to fill the screen.
+
+### WindowUnmaximise
+Go Signature: `WindowUnmaximise(ctx context.Context)`
+
+JS Signature: `WindowUnmaximise()`
+
+Restores the window to the dimensions and position prior to maximising.
+
+### WindowMinimise
+Go Signature: `WindowMinimise(ctx context.Context)`
+
+JS Signature: `WindowMinimise()`
+
+Minimises the window.
+
+### WindowUnminimise
+Go Signature: `WindowUnminimise(ctx context.Context)`
+
+JS Signature: `WindowUnminimise()`
+
+Restores the window to the dimensions and position prior to minimising.
+
+### WindowSetRGBA
+Go Signature: `WindowSetRGBA(ctx context.Context, col *options.RGBA)`
+
+JS Signature: `WindowSetRGBA(col: RGBA)`
+
+Sets the background colour of the window to the given [RGBA](window#rgba) colour definition.
+This colour will show through for all transparent pixels.
+
+Valid values for R, G, B and A are 0-255.
+
+:::info Windows
+
+On Windows, only alpha values of 0 or 255 are supported.
+Any value that is not 0 will be considered 255.
+
+:::
+
+## Typescript Object Definitions
+
+### Position
+
+```ts
+interface Position {
+    x: number;
+    y: number;
+}
+```
+
+### Size
+
+```ts
+interface Size {
+    w: number;
+    h: number;
+}
+```
+
+### RGBA
+
+```ts
+interface RGBA {
+    r,
+    g,
+    b,
+    a: number;
+}
+```
+
+