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

package fyne Animation AnimationCurve App AppMetadata BuildType Canvas CanvasObject Clipboard CloudProvider CloudProviderPreferences CloudProviderStorage Container Delta Device DeviceOrientation Disableable DoubleTappable DragEvent Draggable Driver Focusable HardwareKey KeyboardShortcut KeyEvent KeyModifier KeyName Layout LegacyTheme Lifecycle ListableURI Locale MainMenu Menu MenuItem Notification OverlayStack PointEvent Position Preferences Resource Scrollable ScrollEvent SecondaryTappable Settings Shortcut Shortcutable ShortcutCopy ShortcutCut ShortcutHandler ShortcutPaste ShortcutRedo ShortcutSelectAll ShortcutUndo Size StaticResource Storage StringValidator Tabbable Tappable TextAlign TextStyle TextTruncation TextWrap Theme ThemeColorName ThemedResource ThemeIconName ThemeSizeName ThemeVariant URI URIReadCloser URIWithIcon URIWriteCloser Validatable Vector2 Widget WidgetRenderer Window

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

Fyne API "fyne.WidgetRenderer"

fyne.WidgetRenderer

import "fyne.io/fyne/v2"

Usage

type WidgetRenderer

type WidgetRenderer interface {
	// Destroy is a hook that is called when the renderer is being destroyed.
	// This happens at some time after the widget is no longer visible, and
	// once destroyed, a renderer will not be reused.
	// Renderers should dispose and clean up any related resources, if necessary.
	Destroy()
	// Layout is a hook that is called if the widget needs to be laid out.
	// This should never call [Refresh].
	Layout(Size)
	// MinSize returns the minimum size of the widget that is rendered by this renderer.
	MinSize() Size
	// Objects returns all objects that should be drawn.
	Objects() []CanvasObject
	// Refresh is a hook that is called if the widget has updated and needs to be redrawn.
	// This might trigger a [Layout].
	Refresh()
}

WidgetRenderer defines the behaviour of a widget’s implementation. This is returned from a widget’s declarative object through [Widget.CreateRenderer] and should be exactly one instance per widget in memory.

Improve this page