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
protected

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.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

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.

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

Guides
API
top

Test Runner

Once you’ve authored a few tests for your application, you’ll likely want to run those tests within the browsers you aim to support. Sencha Test’s test runner view allows you to specify the tests you want to run and in which environment. These tests can then run within your machine's browsers in addition to virtual machine browsers, mobile device browsers, and browser farms.

Navigating to a Test Runner

To start, you’ll want to choose your workspace and expand the test project containing the tests you want to run. By default, this would be the "Tests" node from the workspace navigation tree. Applications and packages within a workspace will also have test projects within them that can be initialized. After expanding the target Test Project, select the Scenario from within the test project housing the test specs. By selecting the Scenario from the navigation tree, you’ll see the Scenario’s test runner tab appear on the right.

Sencha Studio Test Runner

Anatomy of a Test Runner

Available Browsers

Sencha Test examines its surrounding environment and displays browsers from your local machine under the heading “Local Browsers” in the “Browsers” view of the test runner tab. This includes multiple versions of the same browser. For instance, you may have a beta version and several past versions of Chrome. These will all be detected and will show up as "Local Browsers".

The version detected by Sencha Test will show up in the right-hand column next to the name of the browser. To the left you'll see a checkbox (as well as a checkbox in the Local Browser header).

In addition to local browsers, you are also able to run the same tests on browsers on other devices on the network or browsers from a remote browser farm (more below).

Sencha Studio Test Runner Browsers View

Scenario Tests

The Scenario view displays the test suites, specs, and expectations in a tree layout with checkboxes next to each node. The checkboxes allow you to indicate the tests you want to run against your target browsers. Additionally, the heading has a checkbox that will allow you run all tests inventoried in your particular scenario. Selecting browsers from the "Browsers" view will add columns next to the available tests. These browser columns will display the outcome of a completed test.

Sencha Studio Test Runner Tests View

Running Tests

Selecting Target Browsers

To begin testing, checkmark one or more browsers as targets for your tests. When working within a Sencha Cmd application, an instance of “app watch” will spin up when you initially select a browser. "app watch" is a background web server instance that assists in coordinating test runs between the parent application and the target browsers.

Sencha Studio Test Runner Chrome Checked

When "app watch" starts, you’ll see an orange “eye” icon next to the application name in the Workspace tree. Once "app watch" initializes and is ready to serve the application, you’ll see the “eye” icon turn gray. You are then able to run your selected tests.

Sencha Studio Test Runner App Watch Running

Running Tests

Once your target browsers are selected, check the box by the tests you wish to run from the tests tree-view and click the "Run Selection" button.

Sencha Studio Test Runner Run Selection

You’ll notice that selecting browsers cause their icons to show up in columns next to the test's list. As the tests proceed, you’ll see that passing tests add a check-mark in the browser column next to that test. Likewise, failed tests will set a red “x”. Parent test suite nodes will have either a green check-mark if all child tests passed or a number indicating the count of fails for that suite. You can terminate an in-progress test run by clicking on the "Stop Run" button in the top toolbar.

Sencha Studio Test Runner Test Passed

Note: In addition to selecting each test individually, you can check the header checkbox to run all tests. Doing so will not toggle tests you may have selected with the tests tree.

When a test fails it will supply details about the failure for each browser experiencing the issue. Click on the red “x” under each affected browser to expand the test summary view below the tests tree. These details will give you an idea of what may need to be addressed in order to find the root cause of the issue.

Sencha Studio Test Runner Test Failed

Additionally, the tests are run within the browser itself, which gives you access to the browser’s developer tools for real-world troubleshooting. Tests can be re-run by clicking on the "Run Selection" button once more. The testing results can be cleared altogether using the "Clear Results" button.

Sencha Studio Test Runner Clear Results

Note: Tests running on browsers in the background can potentially run more slowly than a browser in the foreground due to OS processing prioritization.

Non-Local Browsers

One of the more helpful features built into Sencha Test is the ability to test browsers on devices connected to the same network as the machine running Sencha Test. If you click the "Clear Results" button after running tests with your local browsers, you’ll notice that the URL in the browser tabs is an address like 192.168.1.11:8000. In this example, "192.168.1.11” is the local IP address used by the internal web server by way of Sencha Test. This page is a “parked page” that is effectively linked to Sencha Tests and in a state of waiting for additional tests.

Sencha Studio Parked Browser Page

Note: If multiple local adapters are discovered by Sencha Test, you may see “localhost:8xxx” instead of a literal IP address. In this case you can specify the ideal IP to use within:

Sencha Test > Preferences > Network tab > External Address.

In order to run the same tests on another device on the same network, enter the “parked address” in the browser of another device. We’ll use 192.168.1.11:8000 for the purpose of this guide.

The separate device could be another computer, laptop, tablet or phone. Once you’ve entered 192.168.1.11:8000 in the remote device's browser, you’ll notice that the Browsers view in the test runner tab has a new entry. Local browsers will show up with a heading of "Local Browsers". Externally synced browsers will show up with a heading showing the platform they’re operating within. For example, linking the Safari mobile browser on an iPad shows up as “Safari 9” under a heading of “iOS 9.2”.

Sencha Studio Remote Browsers

Once the remove browser and Sencha Studio are connected you will follow the same steps as when testing local browsers only:

  1. Check the remote browser along with your local browsers
  2. Select the tests to run
  3. Click the "Run Selection" button

The tests will then begin and report back to Sencha Test without any further work from the remote device!

Sencha Studio Remote Results

Note: In the top toolbar of the test runner tab you’ll see a “link” icon. Clicking this button will copy the test target page’s URL to the clipboard. This can be a helpful shortcut when pointing browsers within a Virtual Machine to the Sencha Test runner.

Browser Farms / Pools

Browsers hosted virtually by a browser farm, such as SauceLabs, will also show up as target browsers in the test runner's Browsers view. We'll discuss this topic in greater detail in a future guide.

Running Tests with Test Coverage

The "Run w/ Coverage" button in the top toolbar is also a topic we will discuss in greater detail in a future guide.

Sencha Test 2.0.2

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation