README.md

About

Fyne is an easy to use UI toolkit and app API written in Go. We use the EFL render pipeline to provide cross platform graphics.

This is under heavy development and is not yet capable of supporting a full application

Getting Started

Fyne is designed to be really easy to code with, here are the steps to your first app.

Prerequisites

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

go get github.com/fyne-io/fyne

Code

And then you're ready to write your first app!

    package main

    import "github.com/fyne-io/fyne/widget"
    import "github.com/fyne-io/fyne/app"

    func main() {
    	app := app.New()

    	w := app.NewWindow("Hello")
    	w.SetContent(widget.NewVBox(
    		widget.NewLabel("Hello Fyne!"),
    		widget.NewButton("Quit", func() {
    			app.Quit()
    		}),
    	))

    	w.ShowAndRun()
    }

And you can run that simply as:

go run main.go

It should look like this:

Scaling

Fyne is built entirely using vector graphics which means that applications that are written using it will scale to any value beautifully (not just whole number values). The default scale value is equated from your screen's DPI - and if you move a window to another screen it will re-calculate and adjust the window size accordingly!

Themes

Fyne ships with two themes by default, "light" and "dark". You can choose which to use with the environment variable FYNE_THEME. The default is dark:

If you prefer a light theme then you could run:

FYNE_THEME=light go run main.go

It should then look like this:

Widget demo

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

cd $GOPATH/src/github.com/fyne-io/fyne/cmd/fyne_demo/
go run .

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

Or if you are using the light theme:

Declarative API

If you prefer a more declarative API then that is provided too. The following is exactly the same as the code above but in this different style.

package main

import "github.com/fyne-io/fyne"
import "github.com/fyne-io/fyne/app"
import "github.com/fyne-io/fyne/widget"

func main() {
	app := app.New()

	w := app.NewWindow("Hello")
	w.SetContent(&widget.List{Children: []fyne.CanvasObject{
		&widget.Label{Text: "Hello Fyne!"},
		&widget.Button{Text: "Quit", OnTapped: func() {
			app.Quit()
		}},
	}})

	w.ShowAndRun()
}

Examples

The main examples have been moved - you can find them in their own repository.

Dependencies

You will require a GCC compiler if you do not have one, if on Windows this can be included by installing TDM-GCC. This can be downloaded and installed from http://tdm-gcc.tdragon.net/download