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.

Ext JS 7.1.0


Release Notes for Ext JS 7.1.0 - Jan 16, 2020

Bug Fixes


  • EXTJS-26481 - combo with picker set to edge throws an exception
  • EXTJS-26482 - combo picker does not open full width of viewport after selecting an option when using material theme
  • EXTJS-26588 - Container 'masked' property as config object ignores 'hidden' config
  • EXTJS-26810 - Modern DatePicker throws uncaught error when tapping "Done"
  • EXTJS-27364 - combo with edgePicker highlights items without selecting them
  • EXTJS-28597 - iOS Theme missing Grid Sorting Icons
  • EXTJS-28647 - Modern toolkit: selecting bottom row after scrolling down from active edit of top row selects incorrect row
  • EXTJS-28678 - Add a note to Ext.Panel collapsible/resizable configs about requiring Ext.panel.Collapser/Resizer
  • EXTJS-28682 - Froala Image events are not getting triggered (beforeUpload)


  • EXTJS-16196 - Locking grid throws "Cannot read property 'els' of undefined" on reconfigure in some cases
  • EXTJS-17977 - Floating component does not respect min/max width/height
  • EXTJS-18529 - Tooltips not working when button is disabled
  • EXTJS-19471 - RowEditing buttons are missing/incorrectly sized/cut off on a small grid
  • EXTJS-19655 - tagfield with emptyText does not close on blur
  • EXTJS-20558 - Cannot use method setFilters on store with existing filters
  • EXTJS-24817 - Horizontal scrolling on grid causes column alignment issue if item container extends behind scrollbar
  • EXTJS-25969 - Resizable form field can not be stretched or anchored to fill width
  • EXTJS-26044 - Tagfield values disappear when scroll to bottom
  • EXTJS-26103 - Clicking on a header that has items scrolls the grid
  • EXTJS-26345 - Grids with huge grouped data flicker on scroll
  • EXTJS-26348 - Textarea with configured height < min-height incorrectly computes height in Box layout
  • EXTJS-26388 - RadioGroup does not fire change event after call to reset
  • EXTJS-26522 - Selection model scenarios where allowDeselect not respected
  • EXTJS-26698 - selectOnFocus Property in editable columns of a grid is not respected in IE
  • EXTJS-26754 - Issues using drag and drop between grid to grid with vertical scroll
  • EXTJS-26817 - Value in dropdown field floats invisibly to the left on mouse click
  • EXTJS-27435 - Ext.grid.feature.Grouping remoteGroup does not properly parse when using xml proxy.
  • EXTJS-27449 - Resizable textareafield overlapping existing field in version
  • EXTJS-27455 - Rapid, successive filtering of store for locked grid with widget columns throws error
  • EXTJS-27483 - Single click on cell does not commit first edit and start second when using grouping or groupingsummary features
  • EXTJS-27775] - * [6.6.0 Classic Grouped Grid Buffered renderer Whitespace
  • EXTJS-28414 - Hidden widgetcolumn appears on expand of a resized column
  • EXTJS-28517 - Locking grid renders whitespace on scroll
  • EXTJS-28630 - Stateful Pivot Grid Example is not working


  • EXTJS-28709 - Upgrade the Froala source code, updating it to the latest version at the time of release

Ext JS 7.1.0