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, 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


top

Installation and Setup

Sencha Test contains two applications: Sencha Studio (a GUI application) and stc (a command-line tool). This guide will walk through the installation process and get you ready to start testing! You can also check out the Sencha Test Overview for general product information.

Before getting started, let's review the supported browsers, platforms, and Sencha frameworks. We will then walk through the installation steps.

Supported Platforms

Operating Systems

  • Windows (Win 7+)
  • Mac OS X
  • Linux 32-bit / 64-bit

Browsers

  • Desktop: Internet Explorer 8-11, Edge, Chrome, Firefox, Safari, Opera
  • Mobile (Tablet and Phone): Chrome, Safari, Internet Explorer, Firefox

Sencha Frameworks

  • Ext JS 4.2+
  • Sencha Touch 2.1+

Sencha Tools

Though optional, Sencha Test can interoperate with Sencha Cmd 6.0.2 or higher (6.1.0 is recommended). Sencha Cmd integration can be disabled even if you are using Sencha Cmd.

Other JavaScript Libraries and Frameworks

You may use Sencha Test with any JavaScript-based application or web page, however, Sencha Test includes its own version of Jasmine and Istanbul which may conflict with other versions of these libraries included by the page. In addition, Sencha Test uses the "ST" global object as its namespace.

Installation

You will need to download the zip archive fom the web site.

Installing Sencha Studio and STC

  1. Launch the newly downloaded installer.
  2. Click "Next" to begin the installation.
  3. Accept the license agreement to proceed (select “I accept the agreement” and click "Next").
  4. Choose your install path (if different from the default install path) and click "Next".
  5. (Windows) Check the checkboxes for “Create a Start Menu folder” and “Create shortcuts for all users” (optional) and click "Next".
  6. The installation is now complete. Click "Finish" to close the installer.
  7. Launch Sencha Studio from the install path, desktop icon, or (Windows) Start Menu icon or (Mac) Launchpad.

Dependencies

Embedded Selenium Server

Sencha Test Studio (version 2.0 and above) comes with an embedded Selenium Server instance that can be leveraged to run WebDriver-based scenarios. In order to utilize this functionality, Java 8 (or above) must be installed.

STC and Node.js

To run STC, Node.js must be installed (version 6 or 7) and should be on the system PATH.

License Activation Workflows

Trial License (free for 30 days)

If you are evaluating the product for the first time, follow these steps to download a trial license:

  1. On the initial screen, click Get Started.

  2. Enter the email address used to download the Sencha Test trial.

  3. Click Start Trial.

  4. Wait for the "Activating License" dialog to complete.

  5. You can start using Sencha Test once your activation is successful.

Purchased License (No Trial)

If you have purchased a Sencha Test License and don’t have a trial license:

  1. Click Get Started on the initial screen.

  2. Enter a valid email address and your activation code.

  3. Click Activate.

  4. Wait for the "Activating License" dialog to complete.

  5. You can start using Sencha Test once your activation is successful.

Purchased License (Activation After Trial)

If you have purchased a Sencha Test License and have a working\expired trial license:

  1. Navigate to the License tab on the settings screen. Information about trial license is available on this screen.

  2. Click Activate.

  3. Enter the activation code obtained in the email. Check with the person who purchased the product for your company if you did not receive an email.

  4. Click Activate

  5. Wait for the "Activating License" dialog to complete.

  6. The license is now "Purchase".

Successful Trial (Offline)

If you are evaluating the product for the first time and are unable to download a trial license then follow these steps to get an offline license:

  1. Click Get Started on the initial screen.

  2. Click Offline License.

  3. Enter the email that was used to download Sencha Test.

  4. Click Request Trial

  5. Offline license information is copied to the clipboard.

  6. Paste the information into an email, verify, and send it to activations@sencha.com

  7. A license file will be emailed back to you once Sencha receives the information needed.

  8. Click on Open License File and select the offline license file from Sencha.

  9. Click Open.

  10. The License is validated and you should see the Trial Activation successful screen. Continue on to use Sencha Test.

Purchased License (Activation After Trial Offline)

If you have purchased a Sencha Test License and have a working\expired trial license:

  1. Navigate to the License tab on the settings screen. Information about the trial license should be available on this screen

  2. Click Activate

  3. Enter the activation code obtained in the email. Check with the person who purchased the product for your company if you did not receive an email.

  4. Press Request Activation

  5. Offline license information is copied to the clipboard.

  6. Paste the information into an email, verify, and send it to activations@sencha.com

  7. A license file will be emailed back to you once Sencha receives the information needed.

  8. Click on Open License File and select the offline license file from Sencha.

  9. Click Open.

  10. The License is validated and you should see Trial Activation successful screen. Continue on to use Sencha Test.

Upgrading to Sencha Test 2.x

If you're currently using Sencha Test 1.x and you are upgrading to Sencha Test 2.x, follow these steps:

  1. Download and unzip the Sencha Test 2.x.
  2. Run the installer and select the recommended options
  3. Make sure that your new STC install is added to your PATH variable and takes precedence over the older version

Sencha Test 2 should now be installed on your system. Workspaces created in Sencha Test 1.x can be opened in Sencha Test 2.x.

Uninstalling Sencha Test

  1. Open the "Sencha Test" application folder (e.g., in "C:\Program Files" on Windows, or in "Applications" on Mac).
  2. Double-click the “uninstall” icon.
  3. (Windows) Click "Yes" on the "User Account Control" dialog if applicable.
  4. Click "Next".
  5. Sencha Studio has been uninstalled.
  6. Click "Finish" to close the uninstaller.

Next Steps

Now that Sencha Studio and stc are installed, you can get started writing some tests! If you have further questions, concerns, or bug reports, please visit the Sencha Test forums.

Sencha Test 2.1.1