wails

package module
v1.10.0-pre2.0...-ba9e210 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 4, 2020 License: MIT Imports: 14 Imported by: 0

README


A framework for building desktop applications using Go & Web Technologies.

CodeFactor CodeFactor Awesome Release Pipelines

The traditional method of providing web interfaces to Go programs is via a built-in web server. Wails offers a different approach: it provides the ability to wrap both Go code and a web frontend into a single binary. Tools are provided to make this easy for you by handling project creation, compilation and bundling. All you have to do is get creative!

The official docs can be found at https://wails.app.

Features

  • Use standard Go libraries/frameworks for the backend
  • Use any frontend technology to build your UI
  • Quickly create Vue, Vuetify or React frontends for your Go programs
  • Expose Go methods/functions to the frontend via a single bind command
  • Uses native rendering engines - no embedded browser
  • Shared events system
  • Native file dialogs
  • Powerful cli tool
  • Multiplatform

Installation

Wails uses cgo to bind to the native rendering engines so a number of platform dependent libraries are needed as well as an installation of Go. The basic requirements are:

  • Go 1.13
  • npm

MacOS

Make sure you have the xcode command line tools installed. This can be done by running:

xcode-select --install

Linux

Debian/Ubuntu

sudo apt install libgtk-3-dev libwebkit2gtk-4.0-dev

Debian: 8, 9, 10

Ubuntu: 16.04, 18.04, 19.04

Also succesfully tested on: Zorin 15, Parrot 4.7, Linuxmint 19, Elementary 5, Kali, Neon, Pop!_OS

Arch Linux / ArchLabs / Ctlos Linux

sudo pacman -S webkit2gtk gtk3

Also succesfully test on: Manjaro & ArcoLinux

Centos

sudo yum install webkitgtk3-devel gtk3-devel

CentOS 6, 7

Fedora

sudo yum install webkit2gtk3-devel gtk3-devel

Fedora 29, 30

VoidLinux & VoidLinux-musl

xbps-install gtk+3-devel webkit2gtk-devel

Gentoo

sudo emerge gtk+:3 webkit-gtk

Windows

Windows requires gcc and related tooling. The recommended download is from http://tdm-gcc.tdragon.net/download. Once this is installed, you are good to go.

Installation

Ensure Go modules are enabled: GO111MODULE=on and go/bin is in your PATH variable.

Installation is as simple as running the following command:

go get -u github.com/jls5177/wails/cmd/wails

Next Steps

It is recommended at this stage to read the comprehensive documentation at https://wails.app.

FAQ

  • Is this an alternative to Electron?

    Depends on your requirements. It's designed to make it easy for Go programmers to make lightweight desktop applications or add a frontend to their existing applications. Whilst Wails does not currently offer hooks into native elements such as menus, this may change in the future.

  • Who is this project aimed at?

    Go programmers who want to bundle an HTML/JS/CSS frontend with their applications, without resorting to creating a server and opening a browser to view it.

  • What's with the name?

    When I saw WebView, I thought "What I really want is tooling around building a WebView app, a bit like Rails is to Ruby". So initially it was a play on words (Webview on Rails). It just so happened to also be a homophone of the English name for the Country I am from. So it stuck.

Shoulders of Giants

Without the following people, this project would never have existed:

  • Dustin Krysak - His support and feedback has been immense. More patience than you can throw a stick at (Not long now Dustin!).
  • Serge Zaitsev - Creator of Webview which Wails uses for the windowing.

And without these people, it wouldn't be what it is today. A huge thank you to each and every one of you!

Special Mentions:

  • Byron - At times, Byron has single handedly kept this project alive. Without his incredible input, we never would have got to v1.

This project was mainly coded to the following albums:

Licensing

FOSSA Status

Special Thank You

A special thank you to JetBrains for donating licenses to us!

Please click the logo to let them know your appreciation!

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BuildMode = cmd.BuildModeProd

BuildMode indicates what mode we are in

Functions

This section is empty.

Types

type App 

type App struct {
	// contains filtered or unexported fields
}

App defines the main application struct

func CreateApp 

func CreateApp(optionalConfig ...*AppConfig) *App

CreateApp creates the application window with the given configuration If none given, the defaults are used

func (*App) Bind 

func (a *App) Bind(object interface{})

Bind allows the user to bind the given object with the application

func (*App) Run 

func (a *App) Run() error

Run the app

type AppConfig 

type AppConfig struct {
	// The width and height of your application in pixels
	Width, Height int

	// The title to put in the title bar
	Title string

	// The HTML your app should use. If you leave it blank, a default will be used:
	// <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="IE=edge" content="IE=edge"></head><body><div id="app"></div><script type="text/javascript"></script></body></html>
	HTML string

	// The Javascript your app should use. Normally this should be generated by a bundler.
	JS string

	// The CSS your app should use. Normally this should be generated by a bundler.
	CSS string

	// The colour of your window. Can take "#fff", "rgb(255,255,255)", "rgba(255,255,255,1)" formats
	Colour string

	// Indicates whether your app should be resizable
	Resizable bool

	// Indicated if the devtools should be disabled
	DisableInspector bool
}

AppConfig is the configuration structure used when creating a Wails App object

func (*AppConfig) GetCSS 

func (a *AppConfig) GetCSS() string

GetCSS returns the user CSS

func (*AppConfig) GetColour 

func (a *AppConfig) GetColour() string

GetColour returns the colour

func (*AppConfig) GetDisableInspector 

func (a *AppConfig) GetDisableInspector() bool

GetDisableInspector returns true if the inspector should be disabled

func (*AppConfig) GetHTML 

func (a *AppConfig) GetHTML() string

GetHTML returns the default HTML

func (*AppConfig) GetHeight 

func (a *AppConfig) GetHeight() int

GetHeight returns the desired height

func (*AppConfig) GetJS 

func (a *AppConfig) GetJS() string

GetJS returns the user Javascript

func (*AppConfig) GetResizable 

func (a *AppConfig) GetResizable() bool

GetResizable returns true if the window should be resizable

func (*AppConfig) GetTitle 

func (a *AppConfig) GetTitle() string

GetTitle returns the desired window title

func (*AppConfig) GetWidth 

func (a *AppConfig) GetWidth() int

GetWidth returns the desired width

type CustomLogger 

type CustomLogger = logger.CustomLogger

CustomLogger is a specialised logger

type Runtime 

type Runtime = wailsruntime.Runtime

Runtime is the Go Runtime struct

type Store 

type Store = wailsruntime.Store

Store is a state store used for syncing with the front end

Source Files

View all Source files

Directories

Path Synopsis
cmd
templates/vanilla
wails
lib
binding
event
interfaces
ipc
logger
messages
renderer
renderer/bridge
renderer/webview
Package webview implements Go bindings to https://github.com/zserge/webview C library.
 Package webview implements Go bindings to https://github.com/zserge/webview C library.
Package runtime contains all the methods and data structures related to the runtime library of Wails.
 Package runtime contains all the methods and data structures related to the runtime library of Wails.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.