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 6.6.0


Release Notes for Open Tooling ExtGen 1.0.1

Release Date: Oct 8 2018
ExtGen Version Number: 1.0.1

Refactoring plugin and new classicdesktoplogin template

Release Notes for Ext JS 6.6.0

Release Date: Thu Jun 14 2018
Version Number:

New Features

  • App (5)
    • EXTJS-25100 Router should have an exit action that runs when navigating away
    • EXTJS-26146 Routes should support named parameters with optional type specifiers
    • EXTJS-26199 Routes should support optional patterns
    • EXTJS-26147 Routes should be able to execute when connected
    • EXTJS-26148 Routes should provide a "single" config to disconnect after first use
  • Charts (1)
    • EXTJS-26440 Chart should display multiple tooltips for adjacent Line data points
  • Data (1)
    • EXTJS-18128 Memory and performance optimizations in data package
  • Documentation (1)
    • EXTJS-3885 Ext Direct guide should provide more information
  • Grid (1)
    • EXTJS-22605 Spreadsheet SelectionExtender should be able to reduce the selection
  • Misc (5)
    • EXT-522 Gauge component should support different needle shapes
    • EXT-646 Focus styling should be enabled by default on desktop devices in Classic toolkit
    • EXT-469 Modern toolkit should provide locale support
    • EXT-616 New Graphite theme with improved accessibility in Classic toolkit
    • EXT-146 Modern toolkit should provide a Time Field
  • Tabs (1)
    • EXTJS-26219 Modern Tab Bar should allow non-tab items

Bugs Fixed

  • Accessibility (2)
    • EXTJS-26495 TreePanel accessible widget structure is incorrect
    • EXTJS-25873 Button focus is only shown with x-keyboard-mode
  • App (1)
    • EXTJS-26125 JavaScript errors in route handlers are not shown in the console
  • Button (2)
    • EXTJS-26965 Modern SplitButton should use capital case for button text
    • EXTJS-26674 Modern Button should conform to Material design guidelines in disabled state
  • Calendar (2)
    • EXTJS-26729 Unexpected pop up is coming up in Calendar edit event for Android 7
    • EXTJS-24466 All day events the week after the beginning or end of DST span multiple days
  • Charts (6)
    • EXTJS-26367 Scatter series should have the 'marker' config default to 'true'
    • EXTJS-26045 Improve item highlighting in various chart series
    • EXTJS-26381 Charts should support itemtap event
    • EXTJS-26375 Outlying observation is missing in Box Plot chart
    • EXTJS-26585 Chart DOM legend does not render any data items
    • EXTJS-26311 Chart Axis Calculation/Layout Bug with hidden axis label
  • Core (10)
    • EXTJS-27042 Error in IE8 when Ext JS application is opened in an IFRAME
    • EXTJS-27113 Ext.Date.parse should invalidate value of 0 hours in 'g' time format
    • EXTJS-26349 fails if called from class constructor
    • EXTJS-26439 Child ViewModel store overrides store in parent ViewModel
    • EXTJS-20930 JSON.decode error when JSON includes Line Separator character
    • EXTJS-18443 JSON decoder should throw exception on invalid syntax
    • EXTJS-25761 Breadcrumb does not work after opening a Window and MessageBox
    • EXTJS-13511 Potential XSS attack on Ext.JSON.decode
    • EXTJS-26361 Widget styles defined with an object on the class are not inherited properly
    • EXTJS-5545 Ext.JSON.decode cannot handle certain Unicode characters
  • D3 (1)
    • EXTJS-26306 Setting a hierarchy component store to null does not remove the rendered nodes
  • Data (3)
    • EXTJS-14223 Remove non-native XMLHttpRequest object support
    • EXTJS-26507 Grouping feature using VM buffered store throws error upon binding
    • EXTJS-26358 Implicitly declared id field gets deleted in subclass when gets again as non-id field
  • Documentation (1)
    • EXTJS-27146 Object created with Ext.Object.merge continues to reference the source object
  • Drag (1)
    • EXTJS-26239 Drag proxy uses incorrect font in iOS
  • Events (1)
    • EXTJS-26166 focusEnter and focusLeave (global) do not receive the correct event type
  • Examples (3)
    • EXTJS-26709 Email text field is accepting invalid input
    • EXTJS-26365 Box plot chart caption is not fully displayed on phones
    • EXTJS-19346 XSS vulnerability in restful example
  • Forms (4)
    • EXTJS-25532 Combobox forceSelection does not clear the field on blur when you enter an invalid value
    • EXTJS-26647 Input mask is not applied when data is pasted into the textfield
    • EXTJS-26451 Modern field does not focus when tapped on trigger
    • EXTJS-26118 Native Select/Combo does not open when tapping trigger
  • Grid (24)
    • EXTJS-26839 Cannot Expand Grid Grouper from Unlocked Side in locked grid
    • EXTJS-26960 Checkbox should work when column does not have a dataIndex
    • EXTJS-26928 Filters ignore stateful filters flag on store
    • EXTJS-26910 Navigation Location is not updated when records are shifted
    • EXTJS-26217 Locked Grid editor is shown on column with no editor defined
    • EXTJS-26581 Filters are lost after reordering stateful grid group child columns
    • EXTJS-25743 Grid DragDrop can incorrectly drop when using selection model with mode: 'MULTI'
    • EXTJS-27072 Spreadsheet selection model with checkbox selection enabled doesn't function when multiple cells are selected.
    • EXTJS-26691 Docked summary row ignores column hide/show
    • EXTJS-26422 Cannot focus editor with locked column using rowWidget
    • EXTJS-26845 Grid with a docked summary doesn't autoSize columns correctly
    • EXTJS-26416 Context menu click in scroll bar throws an error
    • EXTJS-26419 Exception thrown closing window with grid cell editing active
    • EXTJS-23161 Sort indicator is reversed on custom sort from menu
    • EXTJS-23387 Cannot prevent sort on checkcolumn if header checkbox is hidden
    • EXTJS-24039 SHIFT selection incorrect on large grid with Spreadsheet SelModel and RowSelect enabled
    • EXTJS-20980 Classic grouped grid scrolls back to focused cell when user expands row
    • EXTJS-25962 Modern Grid selection events are not fired
    • EXTJS-26216 Locked grouping does not show widget after expand
    • EXTJS-19300 Store state is not applied when store binding is used
    • EXTJS-26805 Error when filtering rows in the SpreadsheetModel with selection and BufferedStore
    • EXTJS-24622 Drag indicator not aligned after view scrolled
    • EXTJS-26499 Grid with locking, grouping and cellediting has navigation issues
    • EXTJS-26786 Grid tries to maintain selection when loading store again with selected record
  • Layouts (2)
    • EXTJS-24162 Changing card layout from rowwidget throws recursive exception
    • EXTJS-26355 Modern Card layout incorrectly renders active item when container is not rendered
  • Menu (1)
    • EXTJS-26449 ZIndexManager should put topmost floating component to the front
  • Misc (2)
    • EXTJS-14433 Ext.JSON.encode differs from native JSON.stringify
    • EXTJS-26380 Fieldset legend is not visible in Safari 11
  • PivotGrid (2)
    • EXTJS-27000 Pivot grid exporting produces empty grouping cell
    • EXTJS-26443 Row sub-totals of pivot grid are blank
  • Templates (1)
    • EXTJS-26868 Ext.Template fails to expand tokens containing $ character
  • ToolTips (1)
    • EXTJS-26864 XSS Issue - quicktip decodes html encoded content
  • Tree (1)
    • EXTJS-26086 Tree data with children not set throws error
  • Window (1)
    • EXTJS-26534 Windows not centred in client view when the view is scrolled down.

Ext JS 6.6.0