• Stars
    star
    24,550
  • Rank 890 (Top 0.02 %)
  • Language
    Go
  • License
    Other
  • Created almost 7 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Cross platform GUI toolkit in Go inspired by Material Design

Go API Reference Latest Release Join us on Slack
Code Status Build Status Coverage Status

About

Fyne is an easy-to-use UI toolkit and app API written in Go. It is designed to build applications that run on desktop and mobile devices with a single codebase.

Version 2.4 is the current release of the Fyne API, it added rounded corners, emoji, layout debug support and table headers, along with a large number of smaller feature additions. We are now working towards the next big release, codenamed Elgin and more news will follow in our news feeds and GitHub project.

Prerequisites

To develop apps using Fyne you will need Go version 1.17 or later, a C compiler and your system's development tools. If you're not sure if that's all installed or you don't know how then check out our Getting Started document.

Using the standard go tools you can install Fyne's core library using:

go get fyne.io/fyne/v2@latest

After importing a new module, run the following command before compiling the code for the first time. Avoid running it before writing code that uses the module to prevent accidental removal of dependencies:

go mod tidy

Widget demo

To run a showcase of the features of Fyne execute the following:

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

And you should see something like this (after you click a few buttons):

Fyne Demo Dark Theme

Or if you are using the light theme:

Fyne Demo Light Theme

And even running on a mobile device:

Fyne Demo Mobile Light Theme

Getting Started

Fyne is designed to be really easy to code with. If you have followed the prerequisite steps above then all you need is a Go IDE (or a text editor).

Open a new file and you're ready to write your first app!

package main

import (
	"fyne.io/fyne/v2/app"
	"fyne.io/fyne/v2/container"
	"fyne.io/fyne/v2/widget"
)

func main() {
	a := app.New()
	w := a.NewWindow("Hello")

	hello := widget.NewLabel("Hello Fyne!")
	w.SetContent(container.NewVBox(
		hello,
		widget.NewButton("Hi!", func() {
			hello.SetText("Welcome :)")
		}),
	))

	w.ShowAndRun()
}

And you can run that simply as:

go run main.go

Note

The first compilation of Fyne on Windows can take up to 10 minutes, depending on your hardware. Subsequent builds will be fast.

It should look like this:

Fyne Hello Dark Theme Fyne Hello Dark Theme

Run in mobile simulation

There is a helpful mobile simulation mode that gives a hint of how your app would work on a mobile device:

go run -tags mobile main.go

Another option is to use fyne command, see Packaging for mobile.

Installing

Using go install will copy the executable into your go bin dir. To install the application with icons etc into your operating system's standard application location you can use the fyne utility and the "install" subcommand.

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

Packaging for mobile

To run on a mobile device it is necessary to package up the application. To do this we can use the fyne utility "package" subcommand. You will need to add appropriate parameters as prompted, but the basic command is shown below. Once packaged you can install using the platform development tools or the fyne "install" subcommand.

fyne package -os android -appID my.domain.appname
fyne install -os android

The built Android application can run either in a real device or an Android emulator. However, building for iOS is slightly different. If the "-os" argument is "ios", it is build only for a real iOS device. Specify "-os" to "iossimulator" allows the application be able to run in an iOS simulator:

fyne package -os ios -appID my.domain.appname
fyne package -os iossimulator -appID my.domain.appname

Preparing a release

Using the fyne utility "release" subcommand you can package up your app for release to app stores and market places. Make sure you have the standard build tools installed and have followed the platform documentation for setting up accounts and signing. Then you can execute something like the following, notice the -os ios parameter allows building an iOS app from macOS computer. Other combinations work as well :)

$ fyne release -os ios -certificate "Apple Distribution" -profile "My App Distribution" -appID "com.example.myapp"

The above command will create a '.ipa' file that can then be uploaded to the iOS App Store.

Documentation

More documentation is available at the Fyne developer website or on pkg.go.dev.

Examples

You can find many example applications in the examples repository. Alternatively a list of applications using fyne can be found at our website.

Shipping the Fyne Toolkit

All Fyne apps will work without pre-installed libraries, this is one reason the apps are so portable. However, if looking to support Fyne in a bigger way on your operating system then you can install some utilities that help to make a more complete experience.

Additional apps

It is recommended that you install the following additional apps:

app go install description
fyne_settings fyne.io/fyne/v2/cmd/fyne_settings A GUI for managing your global Fyne settings like theme and scaling
apps github.com/fyne-io/apps A graphical installer for the Fyne apps listed at https://apps.fyne.io

These are optional applications but can help to create a more complete desktop experience.

FyneDesk (Linux / BSD)

To go all the way with Fyne on your desktop / laptop computer you could install FyneDesk as well :)

FyneDesk screenshopt in dark mode

More Repositories

1

examples

Examples apps using the Fyne toolkit
Go
596
star
2

fynedesk

A full desktop environment for Linux/Unix using Fyne
Go
526
star
3

terminal

A graphical terminal emulator for Linux using Fyne
Go
247
star
4

fyne-cross

Cross compiler tool for Fyne apps
Go
237
star
5

fyne-x

Community extensions to the cross platform GUI in Go based on Material Design
Go
233
star
6

defyne

The Fyne IDE
Go
181
star
7

calculator

Fyne Calculator application
Go
47
star
8

fyne-io.github.io

Fyne.io Website
SCSS
37
star
9

developer.fyne.io

Fyne developer documentation website
HTML
27
star
10

solitaire

Fyne solitaire application
Go
26
star
11

pixeledit

A image pixel editing app
Go
20
star
12

apps

Fyne App Browser
Go
18
star
13

apps.fyne.io

A central listing site for available Fyne applications
CSS
17
star
14

fin

A Fyne login manager for linux desktop computers
Go
16
star
15

7guis

Fyne implementation of 7GUIs: A GUI Programming Benchmark - https://eugenkiss.github.io/7guis/
Go
15
star
16

life

Fyne game of life simulation
Go
12
star
17

flatpak_demo

A demo of a Fyne application packaged as a Flatpak.
Go
10
star
18

docs.fyne.io

Documentation website
SCSS
10
star
19

gomobile-bridge

A bridge module for Fyne based mobile apps and libraries that rely on gomobile
Go
7
star
20

tools

Toolchain and helpful commands for building and managing Fyne apps
Go
6
star
21

image

Collection of image codecs useful in GUI apps
Go
5
star
22

setup

Helper tools for getting your development environment set up for Fyne
Go
5
star
23

tutorials

Source code for all of the YouTube / https://developer.fyne.io tutorials
Go
3
star
24

fyne-cross-images

Repository for managing fyne-cross images
Dockerfile
3
star
25

tour.fyne.io

A web based tour of the Fyne toolkit - replaced by developer.fyne.io/tour/
Go
3
star
26

proposals

Proposals that we are working on for future releases
3
star
27

demo.fyne.io

Fyne website to demo running inside a browser
JavaScript
2
star
28

conf.fyne.io

Website for Fyne Conference information
SCSS
1
star
29

cloud

Cloud providers and helpers for the Fyne toolkit
Go
1
star