Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level and inheritance. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Sencha Architect 3.5

Guides
API
top

Sencha Touch View Components in Architect

This guide provides general descriptions of Touch view component categories. When you mouseover a component name in the Toolbox, Architect displays a brief description of the component.

For more information on Touch components, see the Sencha Touch API documentation.

Sencha Touch View Component Categories

The Toolbox organizes Sencha Touch views into the following categories:

Containers

Containers are components that can contain other components. Sencha Touch containers are optimized for mobile apps with touch interfaces. The following Touch containers are available through Architect:

ActionSheet. An Action Sheet component displays a list of buttons in pop-up dialog. ActionSheets are docked at the bottom of the screen, and the default type is set to button.

Carousel. A Carousel lets the user swipe through multiple full-screen cards one at a time. Carousels can be oriented either horizontally or vertically. Think of a Carousel as a single active card with the rest of the cards stretching away left and right, often with indicator dots to show how many available cards there are to swipe through. You can put lists or any other kind of view supported by Touch in a Carousel. Common configs for Carousel include its style, its direction, and whether a finger swipe results in the Carousel moving to the next or previous card.

Container. Touch Container components have all the abilities of Touch Component but let you nest other components inside it, rendering and arranging the child components as needed by your app UI. Most Touch apps have a single top-level Container called a Viewport, which takes up the entire screen, and contains other components. For example, a mail app might use a Viewport with a message list and an email preview pane.

FieldSet. A FieldSet is used to group related fields within a Form Panel, and lets you visually separate elements of a form. For example, an online sales form might divide fields into groups, one for billing address, the other for shipping address. FieldSet can be used on its own or inside a form and optionally has a title at the top and instructions at the bottom.

Form Panel. A Form Panel presents a set of form fields and provides convenient ways to load and save data. Usually a form panel just contains the set of fields you want to display. For example, you could create a simple registration form to sign up to your service using Form Panel. It might include a plain text field for the user's Name, an email field, and a password field.

Menu. A menu can be linked with any side of the screen (top, left, bottom or right) and simply describes the contents of your menu.

Panel. In Touch, a Panel component is most useful as an overlay, that is, a container that “floats” over the rest of your app. Panels can contain extra styling so that when you use the Panel showBy method, the floating Panel appears in a rounded black box over the component it refers to, with a pointer to the other component. If you don’t need this, use Container instead.

sheet. A renderable container that provides base support for orientation-aware transitions for popup or side-anchored sliding Panels.

Tab Panel. Tab Panel components are Panels that include tabs that are each Components (available from the Toolbox Standard category). The tabs include their own functionality and content. Use Tab Panel as a way to let users switch between several full-screen pages. Each Component in the Tab Panel gets its own Tab, which shows the Component when clicked. Tabs can be positioned at the top or the bottom of the Tab Panel, and can optionally accept title and icon configurations.

Ext.Viewport. Viewport is not available as a component to add via the Toolbox in Sencha Touch projects. By default, singleton Viewports are added to projects by the Sencha Touch framework. The Viewport can be configured through the Application node. To do so, select the Application node in the Inspector and look for Viewport in the Config Panel.

Form Fields

Form Fields are components you add to a Form Panel container to create a form. Sencha Touch provides the standard field types used to build almost any kind of form for a mobile app, including Checkbox, Date Picker Field, Email Field, Number Field, Search Field, and so on. To group related fields, place them inside a FieldSet container nested within a Form Panel. For more information about building forms, see Building Sencha Touch Forms with Architect.

Media

Media provides containers for various kinds of media, including audio using the HTML5 Audio element, images of any size that can participate in the layout system just like any other component, and video using the HTML5 Video element.

Pickers

Components that show pickers on the screen, including a date picker and a generic picker as well as Picker Slot used to organize multiple scrollable slots into a single picker.

Standard

Standard components provide basic building blocks for a mobile app UI, including Button, Label, Map, and Spacer components. Standard also includes Component, the basis for all other components. Every Component in Sencha Touch is a subclass of Ext.Component.

Toolbars

Toolbar includes components you use to build toolbars, including Toolbar and Title Bar components. Toolbar components are commonly used as docked items within a Container. They can be docked either top or bottom using the docked config setting. You can insert items -- typically buttons -- and add a title.

Views

Touch View components are used to display dynamic data from a data store, enabling you to have complete control over the formatting and layout of the data through an XTemplate. With DataView, you can create components dynamically that render data from your server backend or any other data source. Also includes List, List Index Bar, Navigation View, Nested List and other components for presenting data from stores.

Sencha Architect 3.5

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation