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

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.


item :  Object

The config object being added.


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 Touch 2.4


Developing BlackBerry 10 Apps

Sencha Touch makes it easy to develop applications designed for the BlackBerry 10 OS.

This guide explains how to create BlackBerry 10 applications using Sencha Touch.

Sencha Touch supports the BlackBerry 10 theme with improved optimization and performance. In addition, support is provided for BlackBerry 10 icons, which you can use to ensure your application has the
BlackBerry look and feel. For more information, see BlackBerry 10 Icons in this guide.

If you are new to BlackBerry 10 development, see the BlackBerry Getting Started guide.

Action Bar

An action bar is an area along the bottom of the screen to display actions and tabs that apply to the screen. Inside the action bar are tabs, which are just buttons in Sencha Touch. If you have too many tabs to display, you need a tab menu (which has the special docked left button on the left). Add the tab menu button component and dock it to the left.

After creating the tab menu and other items that go into the action bar, refer to Adding Menus to a Toolbar to see how to add other components to your action bar.

Touch provides the Ext.ux.TabMenuButton component, which lets you create an action bar tab menu.

Note: TabMenuButton is intended to be docked to the bottom. Attempting to dock anywhere else will result in undesired behavior.

Action Menus

Action menus are a vertical list of actions with captions that slide in from the sides and contain actions used less frequently than those in the action bar. Users open an action menu by tapping an action button on the right side of the action bar.

Context Menus

Context menus are a vertical list of icons without captions that slide in from the sides and provide actions in context with an app. Context menus replace pop-up or graphical context menus. A suitable place for Context menus to appear is when you Ext.List#itemtaphold on an Ext.List.

Application Menus

Application menus provide important actions independent of context, for example, "Settings", "Log Out", and "About". Users open application menus by swiping down from the top of the screen, and dismiss the menus by tapping outside the menu.

Adding Menus to a Toolbar (Action Bar)

The following example shows how to add a menu to an action bar:

BlackBerry 10 Icons

Sencha Touch includes over 50 BlackBerry 10 icons, which you can use in your applications to give the BlackBerry 10 native look and feel to it. You can find the icons in the Sencha Touch /resources/themes/images/bb10/icons directory after you download and unzip the Sencha Touch software installation. Compile these icons into your app.scss CSS before using them in your application. The SCSS file resides in the resources/sass directory in the Sencha Touch installation directory. Add the images that you want to use to the app.scss file,
and use Compass to compile the file and generate the app.css file.

Compass is bundled with Sencha Cmd.

You can use the image in your application with this config statement:

iconCls: 'overflow_tab'

Adding the BlackBerry Theme to app.json

The following example shows how to specify the BlackBerry theme in your Sencha Touch app.json file:

"css": [
    "path": "touch/resources/css/bb10.css",
    "platform": ["chrome", "safari", "ios", "android", "blackberry", "firefox", "ie10"],
    "theme": "Blackberry",
    "update": "delta"

Using the BlackBerry loading indicator

To show the Blackberry 10 loading indicator when your app launches, please insert the following style block into your index.html file:

<style type="text/css">
    html, body {
        height: 100%;
        background-color: #fff

    @keyframes spin {
        0% {

        100% {

    @-webkit-keyframes spinner {
        0% {

        100% {

    #SpinnerContainer .SpinnerShadow,
    #SpinnerContainer .SpinnerRing,
    #SpinnerContainer .SpinnerCenter,
    #SpinnerContainer .Spinner {

    #SpinnerContainer {
        top: 50%;
        left: 50%;
        margin-left: -84px;
        margin-top: -84px;

    #SpinnerContainer .SpinnerShadow {
        box-shadow:0 -2px 2px rgba(0, 0, 0, 0.03), inset 0 2px 6px rgba(0, 0, 0, 0.36), inset 0 -2px 1px rgba(0, 0, 0, 0.06);

    #SpinnerContainer .SpinnerRing {
        border:25px solid rgba(0, 0, 0, 0.13);

    #SpinnerContainer .SpinnerCenter {
        box-shadow:0 -2px 2px rgba(0, 0, 0, 0.06), 0 2px 6px rgba(0, 0, 0, 0.36);

    #SpinnerContainer .Spinner {
        /* base64 image blob */
        background-position:top left;

        -webkit-animation:spinner 1s infinite linear;
        animation:spin 1s infinite linear;

Then add the following code to your body:

<div id="SpinnerContainer">
    <div class="SpinnerRing">
        <div class="SpinnerCenter"></div>
        <div class="Spinner"></div>
    <div class="SpinnerShadow"></div>

Please ensure you remove the default animation element and styling from your index.html, and when your app launches, hide the #SpinnerContainer.

Packaging, Testing, and Deploying a BlackBerry 10 App

Now that you have developed an application for BlackBerry 10 using Sencha Touch, you can run the application on a BlackBerry 10 Simulator or on a BlackBerry 10 device in just a few steps. A complete porting guide and developer video assist you with step-by-step instructions to bring your Sencha Touch application to BlackBerry 10.

More Information

Sencha Touch 2.4

Ext JS
Sencha Test
Sencha Themer
IDE Plugins
Sencha Inspector
Sencha Fiddle
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3



Sencha Themer

1.1.0 1.0.2


4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation