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

Futures API Examples

This guide aims to provide some examples of how the Futures API can be used, and should help illustrate how powerful and flexible they are when testing your web applications.

Ext JS and ExtReact Examples

Reveal Row in a Grid

How to use the .reveal() API to scroll to (reveal) a particular row in a grid.

// URL: http://examples.sencha.com/extjs/6.5.3/examples/kitchensink/?classic#big-data-grid

describe('Grid row reveal', function() {
    it('should scroll to a row in the grid', function() {
        ST.grid('big-data-grid')
            .rowAt(50)
            .reveal();
    });
});

Getting Grid Row's Record

How to get a grid row's underlying record from the Store, and assert one of the values is correct.

// URL: http://examples.sencha.com/extjs/6.5.3/examples/kitchensink/?classic#array-grid

describe('Grid data check', function() {
    it('should contain correct data in the row', function() {
        ST.grid('[title="Basic Grid"]')
            .rowAt(3)
            .getRecord()
            .and(function(row) {
                // Option 1:
                expect(row.data.record.price).toEqual(89.96);

                // Option 2:
                expect(this.future.data.record.price).toEqual(89.96);
            });
    });
});

Filtering a Grid via Column Menu

How to interact with a grid column's menu, define a filter, and check the correct data is being returned from the back end.

Note: WebDriver example

// URL: http://examples.sencha.com/extjs/6.5.3/examples/kitchensink/?classic#grid-filtering

describe('Grid filtering', function() {
    var rowCount;

    it('should add a filter to a column', function() {
        var driver = ST.defaultContext.driver;

        // This code moves the mouse over one of the column's headers which
        // shows the trigger to display the column menu
        ST.element('gridcolumn[text="Company"] => .x-column-header-text-container')
            .get('id')
            .and(function() {
                driver.moveToObject('#' + this.future.data.id);
            });

        // This clicks the column header trigger which displays the column menu
        ST.element('gridcolumn[text="Company"] => .x-column-header-trigger')
            .click();

        // This references the column header menu and clicks the "Filters" item
        // to show the "Filters" sub-menu, then enters a value in to the text
        // field within the filter sub-menu
        ST.component('menu[activeHeader]')
            .gotoComponent('menuitem[text="Filters"]')
            .click()
            .gotoTextField('textfield')
            .focus()
            .type('Inc')
            .wait(1000);    // Filtering has a delay

        // Click away from the column menu to hide it
        ST.component('grid-filtering header')
            .click(); 
    });

    it('should find the grid and get the row count', function() {
        ST.grid('grid-filtering')
            .execute(function(grid) {
                // This function inside of ".execute" runs in the context of 
                // the browser.
                // Get the number of rows in the grid by getting the Store count
                return grid.getStore().getCount(); 
            })
            .and(function(future) {
                rowCount = future.data.executeResult;
            });
    });

    it('Should check the record count', function() {
        // You could check the correct number of records are being returned
        // from your back end when the filter is applied
        expect(rowCount).toEqual(10);
    });

    it('Should check the dataset', function() {
        // You could check the correct records are being returned
        // when your filter is applied
        for (var i = 0; i < rowCount; i ++) {
            // Check the content of each cell as needed
            ST.grid('grid-filtering')
                .rowAt(i)
                .cellAt(1)
                .textLike(/Inc/);
        }
    });
});

Finding a Grid Row by Record ID and Expanding the Row

How to find a grid row by record id, and expand the row.

// URL: http://examples.sencha.com/extjs/6.5.3/examples/kitchensink/?classic#row-expander-grid

describe('Row click', function() {
    it('should find a row with a record id of 4 and expand the row', function() {
        ST.grid('row-expander-grid')
            .rowWith('id', 4)
            .cellAt(0)
            .click();
    });
});

Selecting all Rows in a Grid

How to select all rows in a grid, when a checkbox selection model is being used.

// URL: http://examples.sencha.com/extjs/6.5.3/examples/kitchensink/?classic#checkbox-selection

describe('Grid tests', function() {
    it('should select all rows in the grid', function() {
        // Check all rows in the grid by clicking on CheckColumn header
        ST.component('grid[title="checkOnly: false"] checkcolumn')
            .click();
    });
});

Checking Text of a Toast Message

How to interact with an Ext JS Toast message, and check its text content.

// URL: http://examples.sencha.com/extjs/6.5.3/examples/kitchensink/?classic#toast-view

describe('Toast messages', function() {
    it('should show a toast message when button is clicked', function() {
        // Clicking the button shows a toast message
        ST.button('[text="Simple Toast"]')
            .click();

        // Reference the toast message and check its text
        ST.component('toast')
            .textLike(/Simple Toast/i);
    });
});

Non-Sencha Framework Examples

Checking Table Contents

How to interact with a table using the ST.table Future API, finding a row by index, and checking the text content.

// URL: http://the-internet.herokuapp.com/tables

describe('Table tests', function() {
    it('should find the correct values in the table', function() {
        // Find a row by index, and check text content of a cell
        ST.table('@table1')
            .rowAt(1)
            .cellAt(0)
            .textLike('Smith');
    });
});

Getting Attribute of an Element

How to reference an Element in the page, and retrieve/check some of its attributes.

// URL: http://the-internet.herokuapp.com/login

describe('Login form', function() {
    it('should have correct attributes on the form element', function() {
        // Example 1: get "action" attribute of HTML form
        ST.element('@login')
            .get('action')
            .and(function() {
                // Do something with the attribute value here
                expect(this.future.data.action).toContain('/authenticate');
            });

        // Example 2: check "method" attribute of HTML form
        ST.element('@login')
            .expect('method').toBe('post');
    });
});

Sencha Test 2.3.0