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.4.0


Testing Other Web Applications

Sencha Test is able to help you write and execute end-to-end tests against non-Sencha web applications using WebDriver scenarios.

By using capabilities like the Event Recorder and Inspect tool, you are able to quickly generate unique and stable locators for elements in the page.

This guide walks you through the typical process of using Sencha Test and configuring it to run tests against a non-Sencha web application.

Creating a new Project

  1. Open Sencha Studio, and create a new Project. This example uses an AngularJS "to-do" app, available at

    Sample web app

  2. Use this URL in the "Create Project" window, along with defining a project name and folder path.

    • Name: Name of the project, for example ToDoApp
    • Path: Where the project will be created. Scenarios and test suite files will be added in this location.
    • URL: Web address for the running web app, for example

      Creating a project

  3. Once the project has been created, you will be able to click on the "New Scenario" button to create a scenario that will hold your test suite files.

    • Name: A name for the scenario, for example if you are creating end-to-end tests, you could call the scenario EndToEnd
    • Test type: Selecting WebDriver will run your tests separately from the browser. This is suitable for end-to-end testing. If you have the Test Engineer persona selected in Sencha Studio, this option will be hidden, and new scenarios will default to WebDriver type.

      Creating a scenario

  4. After the scenario has been created, select the scenario in the tree, then click the "New Test Suite" button >> select "Jasmine Test Suite" from the menu. Enter a name for the test suite, for example AddNew. This creates a new Jasmine test suite file. The .js file extension gets added automatically.

    New test suite

  5. With the new test suite loaded in the editor, remove the default expectation, and rename the test/spec to something more meaningful:

    Editing test suite

  6. Start writing some tests by leveraging the Event Recorder or by writing code using the Futures APIs. You can also leverage the Inspect tool to help you create locators for elements. In the screenshot below, the Event Recorder was utilized to create a new to-do item in the app, then the Futures APIs have been used to assert that the new item was added successfully. The Inspect tool helped to generate the locator of the added item:

    Writing tests

    Here is the completed code for the test suite:

     describe("AddNew", function() {
         it("should add a new to-do item", function() {
             // Add a new item to the list using Event Recorder generated script
                 { type: "tap", target: "@new-todo", x: 138, y: 38 },
                 { type: "type", target: "@new-todo", text: "go shopping" },
                 { type: "type", target: "@new-todo", key: "Enter" }
             // Use Futures APIs to check item added to list
                 .textLike('go shopping');
  7. Run the test by selecting the scenario in the tree, choosing a browser (Chrome, for example), and clicking the Run button. You should see a new browser window launch with the app loaded, and the steps carried out. The test should pass after a short wait:

    Running a scenario

Further Information

For more information on scenarios and test suites, see the Projects, Scenarios and Suites guide.

Sencha Test 2.4.0