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

App Metadata

Since release v2.1.0 of the fyne command we support a metadata file that allows you to store information about your application in the repository. This file is optional, but can help to avoid having to remember specific build parameters for each package and release command.

Basic configuration

The file should be named FyneApp.toml in the directory where you run the fyne command (this is normally the main package). The contents of the file are as follows:

Website = "https://example.com"

[Details]
Icon = "Icon.png"
Name = "My App"
ID = "com.example.app"
Version = "1.0.0"
Build = 1

The top portion of the file is metadata that will be used if you upload your app to the Apps listing page, so it is optional.

The Details table contains data about your application that are used in the release process by other app stores and operating systems.

The fyne tool will use this file if it is found, many mandatory command parameters are not required if the metadata is present. You can still override these values by using command line parameters.

Linux & BSD configuration

For Linux and BSD builds there is an optional table called LinuxAndBSD. This table contains additional parameters for a “desktop entry” configuration file of the Fyne app. All parameters are optional, but when present they will be used by the fyne tool (in addition to parameters from the Details table).

The contents of this section is as follows (with example data):

[LinuxAndBSD]
  GenericName = "Web Browser"
  Categories = ["Network"]
  Comment = "View sites on the Internet"
  Keywords = ["browser", "web"]
  ExecParams = "-x 42"

Hint: For instructions on how to define these parameters correctly, please see the Desktop Entry Specification from freedesktop.org.

Improve this page