wailsruntime

README

��# wailsruntime

Documentation

Index

• Variables
• func AwaitWailsCall(pkgName, structName, funcName string, args ...any) []js.Value
• func BrowserOpen(url string)
• func ClipboardGetText() string
• func ClipboardSetText(text string) bool
• func EventsEmit(eventName string, data any)
• func EventsOff(eventName string)
• func EventsOn(eventName string, callback func(args []js.Value) any)
• func EventsOnMultiple(eventNames string, maxCnt int, callback func(args []js.Value) any)
• func EventsOnce(eventName string, callback func(args []js.Value) any)
• func ExitApp()
• func Hide()
• func MainCall(strctName, funcName string, cb func(args []js.Value) any, args ...any) js.Value
• func Show()
• func WailsCall(pkgName, structName, funcName string, cb func(args []js.Value) any, ...) js.Value
• func WindowCenter()
• func WindowFullscreen()
• func WindowGetPosition() (x, y int)
• func WindowGetSize() (width, height int)
• func WindowHide()
• func WindowIsFullScreen() bool
• func WindowIsMaximised() bool
• func WindowIsMinimised() bool
• func WindowMaximise()
• func WindowMinimise()
• func WindowReload()
• func WindowReloadApp()
• func WindowSetAlwaysOnTop(flag bool)
• func WindowSetDarkTheme()
• func WindowSetLightTheme()
• func WindowSetMaxSize(width, height int)
• func WindowSetMinSize(width, height int)
• func WindowSetPosition(x, y int)
• func WindowSetSystemDefaultTheme()
• func WindowSetTitle(title string)
• func WindowSetbackgroundColor(r, g, b, a int8)
• func WindowShow()
• func WindowToggleMaximise()
• func WindowUnFullScreen()
• func WindowUnmaximise()
• func WindowUnminimise()
• func WindowisNormal() bool
• type EnvInfo
  • func Environment() EnvInfo

Variables

var (
	WindowRuntime js.Value = js.Global().Get("window").Get("runtime")
	WindowGo      js.Value = js.Global().Get("window").Get("go")
)

Functions

func AwaitWailsCall

func AwaitWailsCall(pkgName, structName, funcName string, args ...any) []js.Value

Call and await a wails-runtime bound function.

This is best used for go functions which perform shorter operations, since the javascript runtime will be blocked.

func BrowserOpen

func BrowserOpen(url string)

func ClipboardGetText

func ClipboardGetText() string

func ClipboardSetText

func ClipboardSetText(text string) bool

func EventsEmit

func EventsEmit(eventName string, data any)

func EventsOff

func EventsOff(eventName string)

func EventsOn

func EventsOn(eventName string, callback func(args []js.Value) any)

Register a function to be called from javascript.

func EventsOnMultiple

func EventsOnMultiple(eventNames string, maxCnt int, callback func(args []js.Value) any)

func EventsOnce

func EventsOnce(eventName string, callback func(args []js.Value) any)

func ExitApp

func ExitApp()

func Hide

func Hide()

func MainCall

func MainCall(strctName, funcName string, cb func(args []js.Value) any, args ...any) js.Value

Call a wails-runtime bound function in the main package.

func Show

func Show()

func WailsCall

func WailsCall(pkgName, structName, funcName string, cb func(args []js.Value) any, args ...any) js.Value

Call a wails-runtime bound function.

Due to limitations in javascript, we need to await the promise, which is the reason for the callback. ( this could also be fixed if wails exposes an API for their IPC! ;) )

This is best used for go functions which perform longer operations, since the javascript runtime will not be blocked. (http request for example)

func WindowCenter

func WindowCenter()

func WindowFullscreen

func WindowFullscreen()

func WindowGetPosition

func WindowGetPosition() (x, y int)

func WindowGetSize

func WindowGetSize() (width, height int)

func WindowHide

func WindowHide()

func WindowIsFullScreen

func WindowIsFullScreen() bool

func WindowIsMaximised

func WindowIsMaximised() bool

func WindowIsMinimised

func WindowIsMinimised() bool

func WindowMaximise

func WindowMaximise()

func WindowMinimise

func WindowMinimise()

func WindowReload

func WindowReload()

func WindowReloadApp

func WindowReloadApp()

func WindowSetAlwaysOnTop

func WindowSetAlwaysOnTop(flag bool)

func WindowSetDarkTheme

func WindowSetDarkTheme()

func WindowSetLightTheme

func WindowSetLightTheme()

func WindowSetMaxSize

func WindowSetMaxSize(width, height int)

func WindowSetMinSize

func WindowSetMinSize(width, height int)

func WindowSetPosition

func WindowSetPosition(x, y int)

func WindowSetSystemDefaultTheme

func WindowSetSystemDefaultTheme()

func WindowSetTitle

func WindowSetTitle(title string)

func WindowSetbackgroundColor

func WindowSetbackgroundColor(r, g, b, a int8)

func WindowShow

func WindowShow()

func WindowToggleMaximise

func WindowToggleMaximise()

func WindowUnFullScreen

func WindowUnFullScreen()

func WindowUnmaximise

func WindowUnmaximise()

func WindowUnminimise

func WindowUnminimise()

func WindowisNormal

func WindowisNormal() bool

Types

type EnvInfo

type EnvInfo struct {
	BuildType string
	Platform  string
	Arch      string
}

func Environment

func Environment() EnvInfo