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, inheritance, and read only. 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


Using Forms in Sencha Touch

Most apps that require user input make use of forms. In Sencha Touch forms are a wrapper around normal HTML5 forms, with additional options for validating and submitting data, and provide an easy way to lay out fields in an appealing visual style.

Creating a Form

The Form panel presents a set of form fields and provides convenient ways to load and save data. Usually a form panel contains the set of fields that you want to display, ordered inside the items configuration, as shown in the following example:

In this example we created a simple form panel which could be used as a registration form to sign up to a service. We added a plain text for the user's Name, an email and finally a password. In each case we provided a name config on the field for identifying it when we load and save data on the form.

Loading Data

Using the form we created above, we can load data into it in a different ways, the easiest way being the setValues method:

    name: 'Seth',
    email: '[email protected]',
    password: 'secret'

You can also load model instances into a form - for example assuming that you have a User model and want to load a particular instance into the form:

Ext.define('MyApp.model.User', {
    extend: '',
    config: {
        fields: ['name', 'email', 'password']

var ed = Ext.create('MyApp.model.User', {
    name: 'Seth',
    email: '[email protected]',
    password: 'secret'


Retrieving Form Data

Retrieving data from the form panel is usually done using the getValues method:

var values = form.getValues();

// values now looks like this:
    name: 'Seth',
    email: '[email protected]',
    password: 'secret'

It is also possible to listen to change events on individual fields in order to get more timely notification of changes that the user is making. In the following example we expand on the previous code containing the User model, and update the model as soon as any of the fields change:

var form = Ext.create('Ext.form.Panel', {
    listeners: {
        '> field': {
            change: function(field, newValue, oldValue) {
                ed.set(field.getName(), newValue);
    items: [
        // as before

This example used a new capability of Sencha Touch, which enables you to specify listeners on child components of any container. In this case, we attached a listener to the change event of each form field that is a direct child of the form panel. The listener gets the name of the field that fired the change event, and updates the model instance with the new value. For example, changing the email field in the form will update the Model's email field.

Submitting Forms

Sencha Touch provides a number of ways to submit form data. In the previous example we have a Model instance that we have updated, which enables us to use the Model's save method to persist the changes to our server, without using a traditional form submission. Alternatively, we can send a normal browser form submit using the submit method:

    url: 'url/to/submit/to',
    method: 'POST',
    success: function() {
        alert('form submitted successfully!');

In this case we provided the url to submit the form to inside the submit function call - alternatively you can set the url configuration when you create the form. You can specify other parameters (see submit for a full list), including callback functions for success and failure, which are called depending on whether the form submission was successful or not. These functions are usually used to take some action in your app after the data has been saved to the server.

Sencha Touch 2.4