API Documentation
Documentation for developing SailfishOS applicationsCommon Pitfalls in Sailfish Application Development What's New in Silica for Sailfish 2.0
Sailfish Silica Reference
Essential types
Every Sailfish application begins with an ApplicationWindow item, and each application has a single PageStack object containing all of its pages. Additionally, the special Theme object allows applications to style their user interface according to the Sailfish style.
Exposes basic clipboard functionality | |
Exposes the locations of system-standard user directories | |
Top-level component of a Sailfish application | |
Stores and manages the pages of an application | |
Provides device display attributes | |
Provides Sailfish styling properties |
Pages and dialogs
Each page or dialog contains a single screen of application content. A dialog is a type of page that presents content while requesting a confirmation or cancelation action from the user.
A dialog for selecting a color from a ColorPicker | |
A page for selecting a color from a ColorPicker | |
A dialog for selecting a date from a DatePicker | |
A page that is closed by a confirmation or cancelation action | |
A header for use in a Dialog | |
A single page within an application | |
A header for use in a Page | |
A dialog for selecting a time from a TimePicker |
Views and containers
These are used to display or serve as a container for other items. (Note the SilicaFlickable, SilicaListView, and SilicaGridView provide Sailfish-specific behavior and should be used in preference to Flickable, ListView and GridView from the QtQuick module.) Additionally, the ScrollDecorator types provide scroll indicators for views.
Repeatedly instantiates a delegate in a column | |
An expanding panel anchored to the side of an Item | |
A sliding panel with a second panel underneath | |
Adds a horizontal scroll indicator to a flickable Silica view | |
Adds horizontal and vertical scroll indicators to a flickable Silica view | |
A Sailfish-styled flickable view | |
A Sailfish-styled grid view | |
A Sailfish-styled list view | |
A view for flicking through a series of items | |
Adds a vertical scroll indicator to a flickable Silica view | |
Shows a Sailfish-style fullscreen placeholder for an empty view |
Controls
Control components allow users to trigger actions, change values and select options.
An item that lays out Button types | |
A simple Sailfish-styled item for building touch-interactive items | |
Displayed while waiting for content to load or some process to finish | |
Displayed while waiting for content to load or some process to finish | |
A push button with a text label | |
A grid of colors for selecting a color | |
A combo box control for selecting from a list of options | |
A calendar grid for selecting a date | |
A simple Sailfish-styled item for building touch-interactive grid items | |
An image with highlight effect | |
A push button with an image | |
A toggle button with a label and an icon | |
A dialer-type keypad | |
A simple Sailfish-styled item for building touch-interactive list items | |
Displayed while waiting for page to load | |
A paged item view | |
A text field for password entry | |
A horizontal progress bar | |
Shows prompts that brief allow destructive actions to be canceled | |
Shows an item that briefly allows a destructive action to be canceled | |
Shows a pop-up that briefly allows a destructive action to be canceled | |
A horizontal separator | |
A horizontal slider | |
A toggle button with an icon | |
A toggle button with a label | |
A clock face for selecting a time | |
An item that accepts all mouse and touch input | |
A clickable control that displays a label and a value |
Text display and input
Text components can display text and enable text input.
An interactive visual item | |
Styled display of a label and an associated value | |
Controls the appearance and behaviour of the Enter key in the software input panel | |
A monochrome icon | |
A visual item | |
A text label | |
A text paragraph with numbers and addresses automatically highlighted as links | |
A color palette | |
A text field for password entry | |
A text field for entering a text search query | |
Heading text for the start of a section on a page | |
Displays multiple lines of editable plain text | |
Displays a single line of editable plain text |
Menus
Menus allow users to select and trigger an action from a list of options.
Provides a context-specific menu | |
Encapsulates a menu item | |
A static label shown at the beginning of a pulley menu | |
Adds a pull-down menu to a flickable Silica view | |
Adds a push-up menu to a flickable Silica view |
Animations and effects
These are common Silica animations to be applied when fading items or changing the contents of lists, grids and other views. Additionally OpacityRampEffect provides a simple way to fade an item in a linear fashion.
A Sailfish-style item-addition animation | |
A Sailfish-style fade animation | |
A Sailfish-style fade animation that runs outside of the main application UI thread | |
A shader effect that applies an opacity fade gradient | |
A Sailfish-style item-removal animation |
Application covers
Covers are the visual representations of backgrounded applications that are displayed on the running applications screen.
An action for a Cover | |
A list of cover actions | |
An application cover | |
Provides a transparent cover | |
Provides template cover content for a very simple application cover |
Common Pitfalls in Sailfish Application Development What's New in Silica for Sailfish 2.0