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. Note that filtering out private members also filters the API class navigation tree.

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 Web Application Manager 6.0.0


Invoke API

Sencha Web Application Manager is a new way to manage, deploy, and secure HTML5 applications on mobile devices. Invoke is a JavaScript API that lets one application securely run and communicate with another application. You can add the Invoke API to applications that you deploy in Sencha Web Application Manager. Invoke represents a new way of building HTML5 applications. Your applications no longer have to be like islands connected only by a round trip to a server. Using Invoke, applications communicate directly, which lets you build simpler, single purpose applications that expose a simple API.

Using Invoke in the Foreground and Background

Applications can communicate using Invoke:

  • Foreground - Invoke calls enable a user to switch from one application to another. The user can then do work in the second application and when done, Sencha Web Application Client returns the user to the application they started from. A simple example of this is photos. In Sencha Web Application Client, you can have an application that knows where all of your organization's photos are. When another application needs a photo, it redirects the user to the Photos application. The user can select the photos they want, and then the user is returned to the application they started with, and the application has the list of photos the user selected.

  • Background - Invoke calls open up the possibility of a new class of application communication. Applications can exchange data in the background asynchronously without the user needing to leave the application they are currently in. For example, a Contacts application can communicate with a chat application to get the online/offline status of the current contact and update the contact record. The Contacts application need not integrate a chat library or maintain a connection with a chat/presence server. The application only needs to make a simple API call to the chat application running in Sencha Web Application Client.

Include the Sencha Web Application Client APIs

You can add the Invoke API by including one statement in your HTML5 or web site application. The application need not have been created using a Sencha product.

Sample Code
<script src=""></script>

Invoke Applications in the Foreground

To communicate with another application, get a connection to it:

Sample Code'photos').then(send, failure);

If the application doesn't exist or your application doesn't have permission to call that application, Sencha Web Application Client calls your app's failure callback:

Sample Code
var failure = function(error) {
    console.log('Could not find photos app', error);

When you have a connection, your application can start sending messages, in this case, requesting all the photos taken in the current day (time: 1d):

Sample Code
var send = function(connection) {
    connection.send({tags: ['keynote', 'sencha'], time: '1d'}, true).then(usePhoto, failure);

The first parameter of send is the JSON data you want to send to the application. The second parameter is the foreground and background Boolean. A value of true indicates foreground and false is background.

The user is taken to the Photos application, allowed to select photos, and then the Photos application returns the list of photos to your application using a callback:

Sample Code
var usePhoto = function(photos) {
    log('user selected photos', photos);

See the full source code for the Photos application.

Invoke Application in the Background

In the next example, an app calls the chat application in the background to get the presence of a user. The API calls are nearly identical to the previous example, except that second parameter of the send function is set to false to indicate that the application runs in the background.

Sample Code'chat').then(send, failure);

var send = function(connection) {
            {type: 'presence', 
                 user: '[email protected]'}, false)
var success = function(message) {


{user: "[email protected]", connected: true, status: 'away' }

Handling Incoming Messages From Another Application

Handling messages from other applications is accomplished with the onMessage API. The onMessage function receives the JSON message, and creates and returns an request. The Promise must be resolved to return data to the calling application.

Sample Code, message) {
    var promise = new; 
    handleMessage(message, promise); 
    return promise; 

In handleMessage, the user info is fetched asynchronously and the response returns to fulfill the promise, else a rejection message is sent back to the calling application indicating an error.

Sample Code
function handleMessage(message, promise) {
    if(message.type == "presence") {
        this.getUser(message.user, function(user){
            var response = {user:, 
                            connected: user.isConnected, 
                            status: user.status};
    } else {
         promise.reject('Message is not understood');

Sencha Web Application Manager 6.0.0

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

Sencha Test

2.0.0 EA 1.0.3



Sencha Themer

Sencha Themer


5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle