Getting Started

Getting Started Creating your first Fyne app Run Fyne Demo Application and RunLoop Updating Content in your GUI Window Handling Using Goroutines 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 Migrations Compile Options

Drawing and Animation

Rectangle Text Line Circle Image Raster Gradient Animation

Containers and Layout

Box Grid Grid Wrap Border Form Center Stack 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.6 Fyne API v2.6 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

Migrations

In some upgrades the Fyne toolkit may deliver a major feature that is a non-trivial upgrade for larger applications. To allow this to happen without major API changes we have introduced a migrations system. This allows apps to opt in to a new feature or way of working over time, to test the changes carefully and then mark the project as migrated.

It is recommended to stay up to date with migrations within a year of them being introduced, as the toolkit will switch all these features on over time (following deprecation lifecycle).

In v2.6.0 Fyne introduced a new threading model which is the first time we used a migration. If you have not already you should see the details of this feature at Using Goroutines. Once you have adopted this feature follow on to see how a migration is marked as complete.

Opting in to a migration

Migrations are controlled by the new “[Migrations]” section inside FyneApp.toml. Each line in this section is a name for the migration followed by a boolean value to switch it on or off.

You can see below an example metadata file where we have turned on the “fyneDo” migration. This should be done once you have updated your code so that any goroutines in your code use the [fyne.Do] method to ensure the code runs on the toolkit’s main goroutine.

[Details]
  Icon = "Icon.png"
  Name = "Example"
  ID = "com.example.app"

[Migrations]
  fyneDo = true

Testing a migration

It is also possible to test a migration before you mark it as complete - there is a compiler flag that will use this feature for the current build command. For example, to test the fyne.Do migration you could build as follows:

go build -tags migrated_fynedo .

Improve this page