Widget Reference

Core Widgets

Toga includes a set of core widgets, that can be placed with a Box Container.

Component Usage Purpose Class
Application Documentation Primary host for UI components toga.interface.app.App
Box Documentation Container for components toga.interface.widgets.box.Box
Font Documentation Fonts toga.interface.font.Font
Widget Documentation Base class for widgets toga.interface.widgets.base.Widget
Window Documentation Window object toga.interface.window.Window

General widgets

Component Usage Purpose Class
Button Documentation Basic clickable button toga.interface.widgets.button.Button
Image View Documentation Image Viewer toga.interface.widgets.imageview.ImageView
Label Documentation Text label toga.interface.widgets.label.Label
Multiline Text Input Documentation Multi-line Text Input field toga.interface.widgets.multilinetextinput.MultilineTextInput
Number Input Documentation Number Input field toga.interface.widgets.numberinput.NumberInput
Option Container Documentation Option Container toga.interface.widgets.optioncontainer.OptionContainer
Progress Bar Documentation Progress Bar toga.interface.widgets.progressbar.ProgressBar
Selection Documentation Selection toga.interface.widgets.selection.Selection
Text Input Documentation Text Input field toga.interface.widgets.textinput.TextInput
Table Documentation Table of data toga.interface.widgets.table.Table
Tree Documentation Tree of data toga.interface.widgets.tree.Tree

Layout widgets

Component Usage Purpose Class
Scroll Container Documentation Scrollable Container toga.interface.widgets.scrollcontainer.ScrollContainer
Split Container Documentation Split Container toga.interface.widgets.splitcontainer.SplitContainer
Web View Documentation Web View toga.interface.widgets.webview.WebView

Supported Platforms

Component iOS win32 web django cocoa gtk android
toga.interface.widgets.optioncontainer.OptionContainer no no no no yes yes no
toga.interface.widgets.numberinput.NumberInput no yes no no yes yes no
toga.interface.widgets.textinput.TextInput yes yes no yes yes yes no
toga.interface.widgets.progressbar.ProgressBar no no no no yes no no
toga.interface.font.Font yes no no no yes yes no
toga.interface.widgets.box.Box no no no no yes yes no
Image no no no no yes no no
EXPANDING_SPACER no no no no yes yes no
toga.interface.widgets.passwordinput.PasswordInput no yes no no yes no no
toga.interface.widgets.scrollcontainer.ScrollContainer no no no no yes yes no
toga.interface.widgets.splitcontainer.SplitContainer no no no no yes yes no
toga.interface.widgets.imageview.ImageView no no no no yes no no
toga.interface.widgets.webview.WebView yes no no yes yes yes no
toga.interface.widgets.multilinetextinput.MultilineTextInput no yes no no yes no no
TIBERIUS_ICON no no no no yes yes no
Command no no no no yes yes no
toga.interface.widgets.box.Box yes yes no yes yes yes yes
toga.interface.widgets.selection.Selection no no no no yes yes no
toga.interface.widgets.table.Table no no no no yes yes no
toga.interface.widgets.box.Box yes no no yes yes yes yes
toga.interface.app.App yes yes no yes yes yes yes
toga.interface.window.Window yes yes no yes yes yes yes
toga.interface.widgets.tree.Tree no no no no yes yes no
SEPARATOR no no no no yes yes no
toga.interface.widgets.label.Label yes yes no no yes yes no
toga.interface.window.Window yes no no yes yes yes no
SPACER no no no no yes yes no