Getting Started

Getting Started Creating your first Fyne app Run Fyne Demo Application and RunLoop Updating Content in your GUI Window Handling Testing Graphical Apps Packaging for Desktop Mobile Packaging Run in a Browser App Metadata Distributing to App Stores Compiling for different platforms

Exploring Fyne

Canvas and CanvasObject Container and Layouts Widget List Layout List Dialog List Theme Icons Adding Shortcuts to an App Using the Preferences API Adding app translations System Tray Menu Data Binding Compile Options

Drawing and Animation

Rectangle Text Line Circle Image Raster Gradient Animation

Containers and Layout

Box Grid Grid Wrap Border Form Center Max AppTabs

Widgets

Label Button Entry Choices Form ProgressBar Toolbar

Collections

List Table Tree

Data Binding

Data Binding Binding Simple Widgets Two-Way Binding Data Conversion List Data

Extending Fyne

Building a Custom Layout Writing a Custom Widget Bundling resources Creating a Custom Theme Extending Widgets Numerical Entry

Architecture

Geometry Scaling Widgets Organisation and Packages

Frequently Asked Questions

Layout and Widget Size Theme and Customisation Troubleshooting

API Documentation

Upgrade to v2.5 Fyne API v2.5 app canvas container data/binding data/validation dialog driver driver/desktop driver/mobile driver/software lang layout storage storage/repository test theme widget

List My App

Getting Started

Using the Fyne toolkit to build cross platform applications is very simple but does require some tools to be installed before you can begin. If your computer is set up for development with Go then the following steps may not be required, but we advise reading the tips for your operating system just in case. If later steps in this tutorial fail then you should re-visit the prerequisites below.

Prerequisites

Fyne requires 3 basic elements to be present, the Go tools (at least version 1.12), a C compiler (to connect with system graphics drivers) and a system graphics driver. The instructions vary depending on your operating system, choose the appropriate tab below for installation instructions.

Note that these steps are just required for development - your Fyne applications will not require any setup or dependency installation for end users!

Windows
macOS X
Linux
Raspberry Pi
BSD
Android
iOS
Termux (create Android apk without PC - on Android)

The MSYS2 is the recommended approach for working on windows, proceed as follows:

Install MSYS2 from msys2.org
Once installed do not use the MSYS terminal that opens
Open “MSYS2 MinGW 64-bit” from the start menu
Execute the following commands (if asked for install options be sure to choose “all”):
```
 $ pacman -Syu
 $ pacman -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-go
```
You will need to add ~/Go/bin to your $PATH, for MSYS2 you can paste the following command into your terminal:
```
 $ echo "export PATH=\$PATH:~/Go/bin" >> ~/.bashrc
```
For the compiler to work on other terminals you will need to set up the windows %PATH% variable to find these tools. Go to the “Edit the system environment variables” control panel, tap “Advanced” and add “C:\msys64\mingw64\bin” to the Path list.

Downloading

Since Go 1.16 you will need to set up the module before you can use the package.

Run the following command and replace MODULE_NAME with your preferred module name (this should be called in a new folder specific for your application).

$ mkdir myapp
$ cd myapp
$ go mod init MODULE_NAME

You now need to download the Fyne module and helper tool. This will be done using the following commands:

$ go get fyne.io/fyne/v2@latest
$ go install fyne.io/fyne/v2/cmd/fyne@latest

If you are unsure of how Go modules work, consider reading Tutorial: Create a Go module.

Check your installation

Before coding an app or running an example you can check your install using the Fyne Setup tool. Simply download the right app for your computer from the link and run it, you should see something like the following screen:

If there are any problems with your installation see the troubleshooting section for hints.

Run the demo

If you want to see the Fyne toolkit in action before you start to code your own application, you can see our demo app running on your computer by executing:

$ go run fyne.io/fyne/v2/cmd/fyne_demo@latest

Please note that the first run has to compile some C-code and can thus take longer than usual. Subsequent builds reuse the cache and will be much faster.

Installing

If you want to, you can also install the demo using the following command (requires Go 1.16 or later):

$ go install fyne.io/fyne/v2/cmd/fyne_demo@latest

If your GOBIN environment has been added to path (should be by default on macOS and Windows), you can then run the demo:

$ fyne_demo

And that’s all there is to it! Now you can write your own Fyne application in your IDE of choice. If you want to see some Fyne code in action then you can read your first application.

Improve this page