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


top

Requiring Node Modules

For those familiar with Node.js, you will be used to leveraging the require capability to require other classes or Node Modules.

In Sencha Test 2.1+, it is possible to leverage the require capability within WebDriver test suites, to require your own classes or other pre-installed Node Modules.

This significantly increases the power of testing your apps because you will be able to leverage thousands of available packages to quickly and easily extend the capabilities of Sencha Test, for example by looping through data in an Excel spreadsheet using exceljs, or looking up data from a SQL Server database using mssql.

Usage

Requiring Local Files

To require a local file in a WebDriver test suite, you can do the following:

  1. Create a .js class file under the Scenario's "lib" folder:

     module.exports = class MyClass {
         doSomething() {
             // Do something here
         }
     }; 
    
  2. Require the class in your test suite:

     var MyClass = require('./lib/MyClass.js');
    

Requiring Packages

To require a package in a WebDriver test suite, you can do the following:

  1. Run npm init -y within the root of the test folder. This will make the test folder a package, with its own package.json. This only needs to be done once for the test project.

  2. Run npm install <package_name> at the test folder. The package will be installed to the node_modules folder within test, and the package.json will have the specified package added as a dependency. For example:

     npm install exceljs
    

    Note: If you want to leverage an existing globally installed package, you will need to link the package, rather than installing it:

     npm link exceljs
    
  3. Require the package in your test suite:

     var ExcelJS = require('exceljs');
    

Examples

Here are some examples.

Requiring a Local File

This example demonstrates creation and use of a class that contains a test suite to handle the login screen of an application. This class can then be required by any test suites that need to handle login functionality, rather than replicating these steps in multiple test suites.

  1. Create a new WebDriver scenario, using this URL:

     http://examples.sencha.com/extjs/6.5.3/examples/classic/ticket-app/index.html
    
  2. Create a custom class, inside of which is a login method containing a test suite to handle the login screen of an application. This file will be created within the Scenario's lib folder:

    lib/LoginHelper.js:

     'use strict';
    
     module.exports = class LoginHelper {
         login() {
             describe('Login', function() {
                 it('should login to the app', function() {
                     ST.textField('[name="username"]')
                         .setValue('Dan');
    
                     ST.textField('[name="password"]')
                         .setValue('test');
    
                     ST.button('[text="Login"]')
                         .click();
                 });
    
                 it('should show the dashboard after logging in', function() {
                     ST.panel('app-dashboard')
                         .visible();
                 });
             });
         }
     }; 
    
  3. Create a test suite which requires the LoginHelper class:

     describe('Example', function() {
         var LoginHelper = require('./lib/LoginHelper.js'),
             loginHelper = new LoginHelper();
    
         // Run the login test suite
         loginHelper.login(); 
    
         it('should contain data in the tickets grid', function() {
             ST.grid('[reference="activeTickets"]')
                 .rowAt(2);
         });
     });
    
  4. Run the scenario, and the tests should pass.

Requiring a Package

This example demonstrates usage of the exceljs package, for comparison of data from an Excel spreadsheet with data being displayed in an Ext JS grid.

  1. Create a new WebDriver scenario, using this URL:

     http://examples.sencha.com/extjs/6.5.3/examples/kitchensink/?classic#actions-grid
    
  2. Install the exceljs package by following the "Requiring a Package" steps above.

  3. Create a Microsoft Excel .xlsx file in the following folder path:

     /<scenario_folder>/lib/data/LookupData.xlsx
    
  4. Populate the spreadsheet with the following data:

Company Price Change % Change Last Updated
Roodel 59.47 1.23 2.11 10/08/2018
Voomm 41.31 2.64 6.83 10/18/2018
Dabvine 29.94 3.55 13.45 10/11/2018
  1. Create a test suite with the following code:

     describe('Spreadsheet', function() {
         var ExcelJS = require('exceljs'),
             worksheetData;
    
         beforeAll(function(done) {
             var workbook = new ExcelJS.Workbook();
    
             // Strip off test suite file name from folder path
             contextPath = contextPath.substring(0, contextPath.lastIndexOf('/'));
    
             // Read the Excel file
             workbook.xlsx.readFile(contextPath + '/lib/Data/LookupData.xlsx')
                 .then(function(file) {
                     // Get worksheet values
                     worksheetData = file.getWorksheet(1).getSheetValues();
    
                     // Remove first row (contains column/field names)
                     worksheetData.splice(0, 2);
    
                     done();
                 })
                 .catch(function(error) {
                     fail('Unable to read Excel file, with the following exception: ' + error);
                 });
         });
    
         it('Should match the data from the spreadsheet', function() {
             var grid = ST.grid('[title=Actions Grid]'),
                 rowIndex = 0;
    
             // Loop through Excel worksheet rows, and compare text with grid row's cell content
             for (var row of worksheetData) {
                 // Company
                 grid.rowAt(rowIndex)
                     .cellAt(0)
                     .textLike(row[1]);
    
                 // Price
                 grid.rowAt(rowIndex)
                     .cellAt(1)
                     .textLike(row[2].toString());
    
                 rowIndex ++;
             }
         });
     });
    
     // This is needed to obtain the full folder path of this test suite. This has to be placed here.
     var contextPath = module.id;
    
  2. Run the scenario, and the tests should pass if the data from the spreadsheet matches what's shown in the grid.

Sencha Test 2.3.0