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 Test 2.1.1


Testing Existing Applications

Sencha Test can test your existing web applications with minimal setup required. This guide will walk you through the process of setting up a Sencha Test Workspace to test an existing application that is served by a remote server. Of course, because the application could just as easily be served from a local web server, this guide will get you started testing your applications whether you are a developer or a test engineer.

Creating a Project

You can create a new project using the “New Project” button on the welcome screen.

Sencha Studio New Project Button

  1. Click the “New Project” button.
  2. Give the project a name.
  3. Choose the destination Path.
  4. Enter the application URL.
  5. Click "OK".

Create Project

Once the project has been generated, Sencha Studio will open and you can configure the test project by selecting the Tests node:

Setup Workspace

Creating the Test Project

You can change the location for the test project's "project.json" file, but the default location (in the "test" folder) is typically fine. Inside the test project you can create multiple Test Scenarios, which are simply collections of tests that can be run independently.

See the Projects, Scenarios and Suites guide for more depth on the configuration process, but for simplicity in this guide we are only going to change two things:

Because Google uses a lot of global variables on its page, we will disable global leak detection by setting the "Allowed Globals" to the universal wildcard of *.

App Location

Click the Save button and you will see that the Tests node can now be expanded. The children of the Tests node are Scenarios, Page Objects, and lib.

App Location

Creating the Tests

Now that we have a test project and scenario, we can create our first Jasmine tests. To do this inside Sencha Studio, select the scenario and click the "New Test Suite" button in the toolbar.

App Location

Enter a name when prompted, such as "Tests.js". A new node will be added and you can then open the file. The default Jasmine test suite is very simple so we can move right in and start doing some more useful tests.

Test Suite

In the example above we are using the Sencha Test Futures API to locate and manipulate the search field. This begins with the ST.element() call:


This method returns a "future element". This is an object whose methods (focus and type among others) perform their operations on the element once it is available and visible. In other frameworks, these cases are cumbersome to code around, but using the Futures API, this is not an issue.

To run our test, we select the New Scenario node in the tree. This launches the Interactive Test Runner. To get going, we select one of the locally detected browsers (Chrome 48 in this case), and we will see the test tree populate with our Jasmine suite and spec.

Test Runner

This takes place as soon as we select the browser, because Sencha Studio will launch that browser and load the test subject ( in this case) which will load all of our tests. If you look at the URL in the address bar of the browser, however, you will see something like the following instead of the URL we entered:

The address and port point at the local machine. To be more specific, the URL points at Sencha Studio itself. This is because Sencha Test executes tests (in Sencha Studio and the stc command-line) by acting as a middle-man or proxy between the browser and the test page or application. This allows Sencha Test to inject Jasmine and our tests without modifying the test subject.

You can learn more about these details in Using the Test Runner.

Once we hit the Run button, we see some search results!

Test Subject

Note: Because this test manipulates the focus, some browsers will fail if they are not the foreground application. In this case, be sure to switch to that browser window as soon as you hit the Run button.


That is all it takes to get started testing any application. From here you can dig deeper into:

Sencha Test 2.1.1