Contents

Ubuntu User Interface Toolkit

General Topics Base Items

Available through:

import Ubuntu.Components 0.1

AbstractButton

The AbstractButton class defines the behavior of the button.

Action

Describe an action that can be re-used in, for example a Button

ActionList

List of Action items

ActivityIndicator

The ActivityIndicator component visually indicates that a task of unknown duration is in progress, e.g. busy indication, connection in progress indication, etc.

Button

The Button class is DOCME

CheckBox

CheckBox is a component with two states, checked or unchecked. It can be used to set boolean options. The behavior is the same as Switch, the only difference is the graphical style.

Label

The Label class is DOCME

MainView

The root Item for all applications. It automatically adds a header and toolbar for its contents.

Page

A page inside a MainView will have a header and toolbar. Pages can also can be included in Tab object or pushed on a PageStack. Anchors and height of a Page are automatically determined to align with the header of the MainView, but can be overridden.

PageStack

A stack of Page items that is used for inter-Page navigation. Pages on the stack can be popped, and new Pages can be pushed. The page on top of the stack is the visible one. Any non-Page Item that you want to use with PageStack should be created with its visible property set to false.

ProgressBar

The ProgressBar component visually indicates the progress of a process of determinate or indeterminate duration.

Scrollbar

The ScrollBar component provides scrolling functionality for scrollable views (i.e. Flickable, ListView).

Slider

Slider is a component to select a value from a continuous range of values.

Switch

Switch is a component with two states, checked or unchecked. It can be used to set boolean options. The behavior is the same as CheckBox, the only difference is the graphical style.

Tab

Component to represent a single tab in a Tabs environment.

Tabs

The Tabs class provides an environment where multible Tab children can be added, and the user is presented with a tab bar with tab buttons to select different tab pages.

TextArea

The TextArea item displays a block of editable, scrollable, formatted text.

TextCustom

The TextCustom component is here for backward compatibility, please use Label instead

TextField

The TextField element displays a single line of editable plain text. Input constraints can be set through validator or inputMask. Setting echoMode to an appropriate value enables TextField to be used as password input field.

ToolbarActions

List of Action items with additional properties to control a toolbar.

UbuntuShape

The UbuntuShape item provides a standard Ubuntu shaped rounded rectangle.

Clipboard

This is a singleton type providing access to the system clipboard.

MimeData

MimeData type provides interface to access and store data to the Clipboard.

List Items

Available through:

import Ubuntu.Components.ListItems 0.1

Base

Parent class of various list item classes that can have an icon and a progression symbol.

Caption

List item that shows a piece of text.

Divider

Divider to break up list items into groups.

Empty

A list item with no contents. The Empty class can be used for generic list items, containing other components such as buttons. It is selectable, and can take mouse clicks. It will attempt to detect if a thin dividing line at the bottom of the item is suitable, but this behaviour can be over-ridden (using showDivider). For specific types of list items, see its subclasses.

Header

Header for grouping list items together

MultiValue

List item displaying multiple values. This component is under heavy development.

SingleControl

A list item containing a single control

SingleValue

A list item displaying a single value

Standard

The standard list item class. It shows a basic list item with a label (text), and optionally an icon, a progression arrow, and it can have an embedded Item (control) that can be used for including Buttons, Switches etc. inside the list item.

Subtitled

List item displaying a second string under the main label. This component is under heavy development.

ThinDivider

Narrow line used as a divider between ListItems.

ValueSelector

List item displaying single selected value when not expanded, where expanding it opens a listing of all the possible values for selection.

Popovers, Sheets and Dialogs

Available through:

import Ubuntu.Components.Popups 0.1

ActionSelectionPopover

A special popover presenting actions to the user. The popover is closed automatically when the action is chosen.

ComposerSheet

Much like the DefaultSheet the Composer Sheet allows an application to insert a content view over the focused view without disrupting the navigation pattern. However the Composer Sheet is optimised for scenarios in which user content is at risk of corruption, most often (but not solely) when creating or editing content (e.g compose new message). There are two ways to dismiss it: user confirming the manipulation or user cancelling the manipulation, using the "confirm" and "cancel" buttons shown in the right and left side of the composer header.

DefaultSheet

The Default Sheet allows an application to insert a content view over the focused view without disrupting the navigation pattern (tabs state or drill-down path are maintained. When the sheet is dismissed the user continues the journey from the point (s)he left it). The Default Sheet can be closed using either a "close" button (top left) or a "done" button (top right). The sheet cannot be dismissed any other way. Use the doneButton property to configure whether the "close" or the "done" button is used.

Dialog

The Dialog caters for cases in which the application requires the user to determine between optional actions. The Dialog will interrupt the user flow and lock the view for further interaction before the user has selected a desired action. It can only be closed by selecting an optional action confirming or cancelling the operation.

Popover

A popover allows an application to present additional content without changing the view. A popover has a fixed width and automatic height, depending on is contents. It can be closed by clicking anywhere outside of the popover area.

PopupBase

The base class for all dialogs, sheets and popovers. Do not use directly.

SheetBase

Parent class of different types of sheets. Not to be used directly.

Theming Elements

Available through:

import Ubuntu.Components 0.1

ItemStyle

The ItemStyle attached property contains styling properties for a particular UI element.

Theme

The Theme element provides functionality to change the current theme.

Resolution Independence Items

Available through:

import Ubuntu.Components 0.1

Units

Units of measurement for sizes, spacing, margin, etc.