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


What's New in Sencha Test

Sencha Test 2.2.1

Sencha Test 2.2.1 brings some new APIs, along with a number of enhancements and bug fixes. These are detailed in the Release Notes.

New features in this release include:

  • Addition of a doubleClick API for elements and components, to easily execute a double-click action.

  • Addition of a rightClick API for elements and components, to easily execute a right-click / context action.

  • Addition of a getRecord API for DataView Items, enabling the retrieval of the underlying record data for a DataView Item. The same API is already available for Grid Rows.

  • For Sencha Test CLI (STC), there is a new command line switch, --proxyPort, to enable a custom proxy port to be set for In-Browser tests. This can be useful if the application under test needs to be run on a specific port, for example: to enable CORS requests to complete successfully.

Sencha Test 2.2.0

Sencha Test 2.2.0 has new features which make it easier to create tests, manage defects and store results. New features in this release include:

  • Support for ExtReact: write application (end-to-end) tests for ExtReact apps

  • Support for writing application (end-to-end) tests for non-Sencha web applications

  • Create and utilize Page Objects within the Inspect tool to build robust tests for web applications

  • Select and use unique locators using a DOM Tree directly from Sencha Studio using the Inspect tool

  • Visualize tests using a tree view and focus on the test under construction

  • New Futures APIs for interacting with HTML Tables

  • New Futures API for interacting with the Ext JS Slider component

Some of these new features are covered in more detail below.

ExtReact App Support

In this release, you can write application (end-to-end) tests for ExtReact apps. You can either create your tests in a new Sencha Test project, or open the ExtReact app in Sencha Studio and add the tests to the project folder structure itself.

Opening ExtReact Apps in Sencha Studio

In order to open your ExtReact app in Sencha Studio and add your tests to the app folder, the ExtReact app needs to reside within a Sencha Cmd workspace, so that it can be opened in Sencha Studio. This can either be a blank workspace just for the ExtReact app, or one with other Ext JS apps/packages.

Modify the workspace.json file to define the presence of any ExtReact apps, by adding a new extreact config, and defining the folder names of the ExtReact applications that reside within the workspace folder:

    * Array of Ext JS apps
    "apps": [

    * Array of ExtReact apps
    "extreact": {
        "apps": [


When you open the workspace in Sencha Studio, you will see your ExtReact apps show up in the project structure under the "ExtReact Applications" node, and you will be able to add your scenarios and tests. These will be created within a test folder inside of the ExtReact app folder.

ExtReact app support in Sencha Studio

Locators for ExtReact Components

When locating ExtReact components, you can use the capitalized class names of the components in the locators. For example, a panel component in Ext JS would typically use the xtype of panel in its locator:

ST.component('panel[title="My Panel"]');

But in a ExtReact app, the capitalized class name of Panel can also be utilized, as demonstrated in this example:

ST.component('Panel[title="My Panel"]');

This new locator strategy works in apps using ExtReact 6.5.1+.

Testing Other (non-Sencha) Web Applications

The Inspect tool in this release supports the inspection of elements in standard HTML pages; not just Ext JS / ExtReact apps. This enables Sencha Test to be used for testing web applications that aren't using Sencha frameworks.

In combination with the ST.element Future API, and newly added ST.table API, it's possible to more easily author tests that target various HTML elements in the page, including other third-party grid components that render on screen as an HTML table.

For example, using the ST.table API, a test can be written that finds a particular row by string value within a HTML table, and asserts that one of the cells matches a certain value:

it('should find the grid row by string value', function() {
        .textLike(/United States/i);

Or, in this example, reference a table row by index and click on the row:

it('should click the third row in the grid', function() {

Create and utilize Page Objects

Page Objects allow you to create a central lookup list of all the components/elements on a page in the application under test.

You can reuse them in multiple tests by instantiating the page object when needed. This means you can avoid having to copy and paste a locator across multiple test cases, which minimizes the need to modify the locator value when the developer changes the label from "Subject" to something else (for example), or one of the other underlying attributes is changed.

After creating a Page Object, you can leverage it throughout your test suites using the stpo namespace. For example, with a Page Object named AdminDashboard, and a locator named emailView, you can reference that component/element using this code:


For more information, see the guide on Creating and Using Page Objects.

DOM Tree in the Inspect Tool

When inspecting a page, the Inspect tool now shows a Element hierarchy for easier inspection of the DOM Tree. If your web app is not utilizing Sencha frameworks, this means you are now able to leverage the Inspect tool to help you create meaningful and stable locators for elements, and add them to a Page Object, if desired.

DOM Tree in the Inspect tool

Visualize Tests Using a Tree View

We’ve designed a new way to visualize your test code and focus on one test case at a time. This feature helps teams organize tests more effectively and easily take advantage of many other capabilities, including reordering tests via drag and drop, searching and jumping to a specific test in a file, and more importantly, creating an empty test case, launching the Inspect tool, identifying components from the application, and building a test case.

Tree View for Test Suites

The new Tree View for test suites is the default view if you have the Test Engineer persona selected, but this default view can be changed to the Code view if needed, by going to Preferences -> Editor -> checking the "Default to source view for tests" checkbox.

Alternatively, you can switch between the Source view and the Tree view at anytime by using the toggle button in the top-right corner of the editor window.

Sencha Test 2.2.0