tutorials

Documentation

Index

• Variables
• type Tutorial

Variables

var (
	// Tutorials defines the metadata for each tutorial
	Tutorials = map[string]Tutorial{
		"welcome": {"Welcome", "", welcomeScreen},
		"canvas": {
			"Canvas",
			"See the canvas capabilities.",
			canvasScreen,
		},
		"animations": {
			"Animations",
			"See how to animate components.",
			makeAnimationScreen,
		},
		"icons": {
			"Theme Icons",
			"Browse the embedded icons.",
			iconScreen,
		},
		"containers": {
			"Containers",
			"Containers group other widgets and canvas objects, organising according to their layout.\n" +
				"Standard containers are illustrated in this section, but developers can also provide custom " +
				"layouts using the fyne.NewContainerWithLayout() constructor.",
			containerScreen,
		},
		"apptabs": {
			"AppTabs",
			"A container to help divide up an application into functional areas.",
			makeAppTabsTab,
		},
		"border": {
			"Border",
			"A container that positions items around a central content.",
			makeBorderLayout,
		},
		"box": {
			"Box",
			"A container arranges items in horizontal or vertical list.",
			makeBoxLayout,
		},
		"center": {
			"Center",
			"A container to that centers child elements.",
			makeCenterLayout,
		},
		"doctabs": {
			"DocTabs",
			"A container to display a single document from a set of many.",
			makeDocTabsTab,
		},
		"grid": {
			"Grid",
			"A container that arranges all items in a grid.",
			makeGridLayout,
		},
		"split": {
			"Split",
			"A split container divides the container in two pieces that the user can resize.",
			makeSplitTab,
		},
		"scroll": {
			"Scroll",
			"A container that provides scrolling for its content.",
			makeScrollTab,
		},
		"innerwindow": {
			"InnerWindow",
			"A window that can be used inside a traditional window to contain a document or content.",
			makeInnerWindowTab,
		},
		"widgets": {
			"Widgets",
			"In this section you can see the features available in the toolkit widget set.\n" +
				"Expand the tree on the left to browse the individual tutorial elements.",
			widgetScreen,
		},
		"accordion": {
			"Accordion",
			"Expand or collapse content panels.",
			makeAccordionTab,
		},
		"activity": {
			"Activity",
			"A spinner indicating activity used in buttons etc.",
			makeActivityTab,
		},
		"button": {
			"Button",
			"Simple widget for user tap handling.",
			makeButtonTab,
		},
		"card": {
			"Card",
			"Group content and widgets.",
			makeCardTab,
		},
		"entry": {
			"Entry",
			"Different ways to use the entry widget.",
			makeEntryTab,
		},
		"form": {
			"Form",
			"Gathering input widgets for data submission.",
			makeFormTab,
		},
		"input": {
			"Input",
			"A collection of widgets for user input.",
			makeInputTab,
		},
		"text": {
			"Text",
			"Text handling widgets.",
			makeTextTab,
		},
		"toolbar": {
			"Toolbar",
			"A row of shortcut icons for common tasks.",
			makeToolbarTab,
		},
		"progress": {
			"Progress",
			"Show duration or the need to wait for a task.",
			makeProgressTab,
		},
		"collections": {
			"Collections",
			"Collection widgets provide an efficient way to present lots of content.\n" +
				"The List, Table, and Tree provide a cache and re-use mechanism that make it possible to scroll through thousands of elements.\n" +
				"Use this for large data sets or for collections that can expand as users scroll.",
			collectionScreen,
		},
		"list": {
			"List",
			"A vertical arrangement of cached elements with the same styling.",
			makeListTab,
		},
		"table": {
			"Table",
			"A two dimensional cached collection of cells.",
			makeTableTab,
		},
		"tree": {
			"Tree",
			"A tree based arrangement of cached elements with the same styling.",
			makeTreeTab,
		},
		"gridwrap": {
			"GridWrap",
			"A grid based arrangement of cached elements that wraps rows to fit.",
			makeGridWrapTab,
		},
		"dialogs": {
			"Dialogs",
			"Work with dialogs.",
			dialogScreen,
		},
		"windows": {
			"Windows",
			"Window function demo.",
			windowScreen,
		},
		"binding": {
			"Data Binding",
			"Connecting widgets to a data source.",
			bindingScreen,
		},
		"advanced": {
			"Advanced",
			"Debug and advanced information.",
			advancedScreen,
		},
	}

	// TutorialIndex  defines how our tutorials should be laid out in the index tree
	TutorialIndex = map[string][]string{
		"":            {"welcome", "canvas", "animations", "icons", "widgets", "collections", "containers", "dialogs", "windows", "binding", "advanced"},
		"collections": {"list", "table", "tree", "gridwrap"},
		"containers":  {"apptabs", "border", "box", "center", "doctabs", "grid", "scroll", "split", "innerwindow"},
		"widgets":     {"accordion", "activity", "button", "card", "entry", "form", "input", "progress", "text", "toolbar"},
	}
)

var OnChangeFuncs []func()

OnChangeFuncs is a slice of functions that can be registered to run when the user switches tutorial.

Types

type Tutorial

type Tutorial struct {
	Title, Intro string
	View         func(w fyne.Window) fyne.CanvasObject
}

Tutorial defines the data structure for a tutorial