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.




This chapter introduces you to some common terms and definitions you will need when testing websites and apps. If you want to start working with Sencha WebTestIt right away, you can skip this chapter and start to Create your first test.

Why test automation?

You might be familiar with the typical software development process: Developers write code based on a specification of some sort and as a tester, it is your job to verify it works as intended. Usually, you start this by composing Test cases, which describe your website’s or app’s expected behavior.


Among other purposes, test cases serve as documentation on how an app’s functionality was verified. They can be used by others in your organization to test the software in the same way as you initially defined it.

Back in the days of classic software development, testing meant that at a certain point you would have to take all your test cases and verify them against your website or application. Nowadays we work in agile processes, which focus on faster releases and shorter iterations, which means you must adapt and verify your test cases more often. Along with this some serious problems arise:

  • Your work becomes more monotonous because you have to verify the same test cases over and over again
  • There is a higher potential for missing out on something due to routine
  • As software grows more complex and the number of test cases rises it becomes hard to deliver results on time
  • In large projects, often only modified parts of the software are tested, although it is hard to assess the dependencies of components under the hood.
    This contributes to a risk of leaving growing technical debts undiscovered.

Above issues can be avoided easily by automating them. Machines excel in doing repetitive tasks and they are based on simple logic. You can rest assured that thanks to that every single test case is executed in the same way, every time. Enter the world of test automation.

What is Sencha WebTestIt?

Sencha WebTestIt is a lightweight editor and toolset optimized for creating and executing UI tests for websites and web apps. Tests written in Sencha WebTestIt are apps that control your browser and therefore simulate a user on your website or app.


The process of remote controlling the browser is called browser automation and is enabled by an API called WebDriver. All modern browsers support WebDriver on desktops, tablets, and phones.

With the help of automated tests, you can save a lot of time and do not have to manually repeat your test cases over and over again. Sencha WebTestIt helps you to set up your environment for executing those tests, manages Page Objects for you and provides you with a powerful editor to script the actual test cases.

Automation frameworks and languages

To compose machine- and human-readable test cases you need to utilize Application Programming Interfaces (APIs) that ensure a proper translation of the steps to the test program. You can use different automation frameworks and programming languages to write your tests. Sencha WebTestIt supports Selenium, Protractor and unittest as frameworks for test automation.


Sencha WebTestIt sets up your environment and gets you going for directly starting test development. You do not need to worry about configuring or setting up your machine first.

To create tests and Page Objects in Sencha WebTestIt, you need knowledge in one of the supported programming languages. Find tutorials for Java, TypeScript, and Python in the following links:

Selectors and page objects

Your website or app consists of a set of HTML components, which are rendered on screen by the browser. The user interacts with those elements by clicking them, entering values through the keyboard, and so forth.


Thanks to web design efforts and decades of computer usage it is easy for humans to identify various elements within a website or app. We trained ourselves over time how to interact with input elements and where to locate them even with changing designs.

To interact with those same elements in your tests, you need to tell the automation framework how to identify and access them properly. You do this by referring to them through Selectors. With information provided by a selector, the automation framework locates elements in your website’s or app’s UI structure.

Sencha WebTestIt comes with powerful tools to organize your selectors into Page Objects and manage them. You can learn more about Page Objects in Chapter 3 of this guide.


An Endpoint is a set of configurations for executing your test. As a tester, you want to make sure that your website or app works across a variety of different browsers and operating systems. With the help of Endpoints, you can do just that.

Sencha WebTestIt helps you in configuring and managing Endpoints for executing your Tests. You can learn more about Endpoints in Chapter 4 of this guide.

Things you need to write tests

You need some basic programming knowledge in the supported programming languages described above. In addition to that, we recommend that you get familiar with one of the supported testing frameworks. You can find tutorials for Protractor, Selenium WebDriver and unittest at their official websites.