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.7.0 - Classic Toolkit

Guide applies to: classic

Diff between Ext JS 6.6.0 and Ext JS 6.7.0 (classic)

Added Classes

  • (private)
  • (private)
  • (private)
  • (private)
  • Ext.mixin.Watchable (private)
  • Ext.Responsive
  • Ext.ResponsiveWidget (private)
  • Ext.util.BasicFilter (private)

Modified Classes


  • Added Methods
    • watchConfig (private)


  • extends is Object (was Ext.Base)


  • Modified Configs
    • childEls
      • value
            frameTable: {
                frame: true
            frameTL: {
                frame: 'tl'
            frameTC: {
                frame: 'tc'
            frameTR: {
                frame: 'tr'
            frameML: {
                frame: 'ml'
            frameBody: {
                frame: 'mc'
            frameMR: {
                frame: 'mr'
            frameBL: {
                frame: 'bl'
            frameBC: {
                frame: 'bc'
            frameBR: {
                frame: 'br'

Ext.Configurator (private)

  • Added Methods
    • hoistConfigs (private)
  • Modified Methods
    • merge (private)
      • Param Changes
        • clone (new)

  • extends is Object (was Ext.Base)

  • alias is data.amf.remotingmessage (was undefined)
  • extends is Ext.Base (was Object)

  • extends is Object (was Ext.Base)

  • alias is data.amf.xmlencoder (was undefined)
  • extends is Ext.Base (was Object) (private)

  • Modified Methods
    • open
      • Param Changes
        • isAsync (was async)

  • Modified Methods
    • openRequest (private)
      • Param Changes
        • isAsync (was async)

  • Modified Properties
    • BOOL
      • value
            convert: function(v) {
                if (typeof v === 'boolean') {
                    return v;
                if (this.getAllowNull() && (v === undefined || v === null || v === '')) {
                    return null;
                return v === 'true' || v == 1;
            // eslint-disable-line eqeqeq
            sortType: SortTypes.none,
            type: 'bool'
    • DATE
      • value
            convert: function(v) {
                var df = this.getDateReadFormat() || this.getDateFormat(),
                if (!v) {
                    return null;
                // instanceof check ~10 times faster than Ext.isDate. Values here will not be cross-document objects
                // instanceof check ~10 times faster than Ext.isDate. Values here will not
                // be cross-document objects
                if (v instanceof Date) {
                    return v;
                if (df) {
                    return Ext.Date.parse(v, df);
                parsed = Date.parse(v);
                return parsed ? new Date(parsed) : null;
            sortType: SortTypes.asDate,
            type: 'date'
    • stripRe
      • value is /[$,%]/g (was /[\$,%]/g)

  • Modified Configs
    • matcher
      • value
        new RegExp('^ *' + // optional country code
        '(?:' + '\\+?' + // maybe + prefix
        '(\\d{1,3})' + // optional separator
        '[- .]?' + ')?' + // optional area code
        '(?:' + '(?:' + '(\\d{3})' + //without ()
        '|' + '\\((\\d{3})\\)' + //with ()
        '(?:' + '(?:' + '(\\d{3})' + // without ()
        '|' + '\\((\\d{3})\\)' + // with ()
        ')?' + // optional separator
        '[- .]?' + ')' + // CO code (3 digit prefix)
        '(?:' + '([2-9]\\d{2})' + // optional separator
        '[- .]?' + ')' + // line number (4 digits)
        '(\\d{4})' + // optional extension
        '(?: *(?:e?xt?) *(\\d*))?' + ' *$')


  • Modified Methods
    • parse
      • Modified Params
        • format
          • optional is true (was undefined)
        • undefined
          • type is Date (was Date/null)


  • Added Methods
    • lock
    • unlock

  • extends is Object (was


  • extends is Object (was Ext.Base)


  • Added Methods
    • getLocalXY (private)
  • Modified Methods
    • getWheelDelta
      • deprecatedMessage is
        Use {@link #property!deltaY #deltaY} instead
    • getWheelDeltas
      • deprecatedMessage is
        Use {@link #property!deltaX #deltaX} and {@link #property!deltaY #deltaY} instead


  • Modified Methods
    • onWindowResize
      • deprecatedMessage is
        Use {@link Ext#method!on Ext.on}('resize', fn) to attach a window resize
        Use {@link Ext#method!on Ext.on}('resize', fn) to attach a window resize listener.


  • Modified Configs
    • triggers
      • value
            filebutton: {
                type: 'component',
                hideOnReadOnly: false,
                // Most form fields prevent the default browser action on mousedown of the trigger.
                // This is intended to prevent the field's input element from losing focus when
                // the trigger is clicked.  File fields disable this behavior because:
                // 1. The input element does not receive focus when the field is focused. The button does.
                // 1. The input element does not receive focus when the field is focused.
                // The button does.
                // 2. Preventing the default action of touchstart (translated from mousedown
                // on mobile browsers) prevents the browser's file dialog from opening.
                preventMouseDown: false


  • Modified Configs
    • ariaHelpTextEditable
      • value
        'Use Up and Down arrows to view available values, Enter to select. ' + 'Type and press Enter to create a new value. ' + 'Use Left and Right arrows to view selected values, Delete key to deselect.'
        'Use Up and Down arrows to view available values, Enter to select. ' + 'Type and press Enter to create a new value. ' + 'Use Left and Right arrows to view selected values, ' + 'Delete key to deselect.'

  • extends is (was Object)

  • extends is (was Object)


  • extends is Ext.mixin.Observable (was Ext.mixin.Observable,Object)


  • Added Configs
    • glyphorig


  • extends is Ext.Gadget (was Ext.Gadget,Object)


  • extends is Ext.list.AbstractTreeItem (was Ext.list.AbstractTreeItem,Object)


  • extends is Ext.Base (was Ext.Base,Object)


  • Modified Configs
    • responsiveFormulas
      • value is null (was 0)


  • Modified Configs
    • ownerListeners
      • value is **
        destroyable: true,
        storechange: 'onOwnerStoreChange'
        * was
        destroyable: true,
        storechange: 'onStoreChange'

Ext.parse.Parser (private)

  • Modified Configs
    • infix
      • value
            //'===': 40,
            //'!==': 40,
            //'<': 40,
            //'<=': 40,
            //'>': 40,
            //'>=': 40,
            '===': 40,
            '!==': 40,
            '==': 40,
            '!=': 40,
            '<': 40,
            '<=': 40,
            '>': 40,
            '>=': 40,
            '+': 50,
            '-': 50,
            '*': 60,
            '/': 60

Ext.parse.Tokenizer (private)

  • Modified Configs
    • operators
      • value
            '+': 'plus',
            '-': 'minus',
            '*': 'multiply',
            '/': 'divide',
            '!': 'bang',
            '!': 'not',
            ',': 'comma',
            ':': 'colon',
            '[': 'arrayOpen',
            ']': 'arrayClose',
            '{': 'curlyOpen',
            '}': 'curlyClose',
            '(': 'parenOpen',
            ')': 'parenClose'


  • Modified Configs
    • dayNames
      • deprecatedMessage
        This config is deprecated. In future the day names will be retrieved from {@link Ext.Date}
        This config is deprecated. In future the day names will be retrieved
        from {@link Ext.Date}
    • monthNames
      • deprecatedMessage
        This config is deprecated. In future the month names will be retrieved from {@link Ext.Date}
        This config is deprecated. In future the month names will be retrieved
        from {@link Ext.Date}
    • renderTpl
      • value
            '<div id="{id}-innerEl" data-ref="innerEl" role="presentation">',
            '<div class="{baseCls}-header">',
            '<div id="{id}-prevEl" data-ref="prevEl" class="{baseCls}-prev {baseCls}-arrow" role="presentation" title="{prevText}"></div>',
            '<div id="{id}-middleBtnEl" data-ref="middleBtnEl" class="{baseCls}-month" role="heading">{%this.renderMonthBtn(values, out)%}</div>',
            '<div id="{id}-nextEl" data-ref="nextEl" class="{baseCls}-next {baseCls}-arrow" role="presentation" title="{nextText}"></div>',
            '<table role="grid" id="{id}-eventEl" data-ref="eventEl" class="{baseCls}-inner" cellspacing="0" tabindex="0" aria-readonly="true">',
            '<tr role="row">',
            '<tpl for="dayNames">',
            '<th role="columnheader" class="{parent.baseCls}-column-header" aria-label="{.}">',
            '<div role="presentation" class="{parent.baseCls}-column-header-inner">{.:this.firstInitial}</div>',
            '<tr role="row">',
            '<tpl for="days">',
            '<td role="gridcell">',
            '<div hidefocus="on" class="{parent.baseCls}-date"></div>',
            '<tpl if="showToday">',
            '<div id="{id}-footerEl" data-ref="footerEl" role="presentation" class="{baseCls}-footer">{%this.renderTodayBtn(values, out)%}</div>',
            // These elements are used with Assistive Technologies such as screen readers
            '<div id="{id}-todayText" class="' + Ext.baseCSSPrefix + 'hidden-clip">{todayText}.</div>',
            '<div id="{id}-ariaMinText" class="' + Ext.baseCSSPrefix + 'hidden-clip">{ariaMinText}.</div>',
            '<div id="{id}-ariaMaxText" class="' + Ext.baseCSSPrefix + 'hidden-clip">{ariaMaxText}.</div>',
            '<div id="{id}-ariaDisabledDaysText" class="' + Ext.baseCSSPrefix + 'hidden-clip">{ariaDisabledDaysText}.</div>',
            '<div id="{id}-ariaDisabledDatesText" class="' + Ext.baseCSSPrefix + 'hidden-clip">{ariaDisabledDatesText}.</div>',
                firstInitial: function(value) {
                    return Ext.picker.Date.prototype.getDayInitial(value);
                isEndOfWeek: function(value) {
                    // convert from 1 based index to 0 based
                    // by decrementing value once.
                    // eslint-disable-next-line vars-on-top
                    var end = value % 7 === 0 && value !== 0;
                    return end ? '</tr><tr role="row">' : '';
                renderTodayBtn: function(values, out) {
                    Ext.DomHelper.generateMarkup(values.$comp.todayBtn.getRenderTree(), out);
                renderMonthBtn: function(values, out) {
                    Ext.DomHelper.generateMarkup(values.$comp.monthBtn.getRenderTree(), out);


  • Modified Configs
    • mztype
      • deprecatedMessage
        Use {@link #cfg!type #type} instead. The old type config was renamed to {@link #cfg!operator #operator}.
        Use {@link #cfg!type #type} instead. The old type config was renamed to
        {@link #cfg!operator #operator}.


  • extends is Ext.Base (was Ext.Base,Object)
  • mixins is Ext.mixin.Identifiable (was undefined)


  • extends is Ext.plugin.Abstract (was Ext.mixin.Responsive)


  • extends is Ext.plugin.Abstract (was Ext.plugin.Responsive)


  • alternateClassNames is Ext.scroll.NativeScroller (was undefined)


  • Added Configs
    • editRenderer
    • renderer


  • extends is Ext.Gadget (was Ext.Gadget,Object)


  • Modified Properties
    • accessibility
      • value is 'accessibility' (was undefined)
    • AsyncFocusEvents
      • value is 'AsyncFocusEvents' (was undefined)
    • BoundingClientRect
      • value is 'BoundingClientRect' (was undefined)
    • ChildContentClearedWhenSettingInnerHTML
      • value is
    • ComputedStyle
      • value is 'ComputedStyle' (was undefined)
    • CSS3BorderRadius
      • value is 'CSS3BorderRadius' (was undefined)
    • CSS3LinearGradient
      • value is 'CSS3LinearGradient' (was undefined)
    • Direct2DBug
      • value is 'Direct2DBug' (was undefined)
    • DisplayChangeInputSelectionBug
      • value is 'DisplayChangeInputSelectionBug' (was undefined)
    • DisplayChangeTextAreaSelectionBug
      • value is 'DisplayChangeTextAreaSelectionBug' (was undefined)
    • EmulatedMouseOver
      • value is 'EmulatedMouseOver' (was undefined)
    • FixedTableWidthBug (private)
      • value is 'FixedTableWidthBug' (was undefined)
    • Float
      • value is 'Float' (was undefined)
    • FocusinFocusoutEvents (private)
      • value is 'FocusinFocusoutEvents' (was undefined)
    • matchesSelector
      • value is 'matchesSelector' (was undefined)
    • MouseEnterLeave
      • value is 'MouseEnterLeave' (was undefined)
    • MouseWheel
      • value is 'MouseWheel' (was undefined)
    • Opacity
      • value is 'Opacity' (was undefined)
    • PercentageHeightOverflowBug (private)
      • value is 'PercentageHeightOverflowBug' (was undefined)
    • Placeholder
      • value is 'Placeholder' (was undefined)
    • RightMargin
      • value is 'RightMargin' (was undefined)
    • RotatedBoundingClientRect
      • value is 'RotatedBoundingClientRect' (was undefined)
    • rtlVertScrollbarOnRight (private)
      • value is 'rtlVertScrollbarOnRight' (was undefined)
    • rtlVertScrollbarOverflowBug (private)
      • value is 'rtlVertScrollbarOverflowBug' (was undefined)
    • ScrollWidthInlinePaddingBug
      • value is 'ScrollWidthInlinePaddingBug' (was undefined)
    • SpecialKeyDownRepeat
      • value is 'SpecialKeyDownRepeat' (was undefined)
    • TextAreaMaxLength
      • value is 'TextAreaMaxLength' (was undefined)
    • TranslateYCausesHorizontalScroll (private)
      • value is 'TranslateYCausesHorizontalScroll' (was undefined)
    • TransparentColor
      • value is 'TransparentColor' (was undefined)
    • xOriginBug (private)
      • value is 'xOriginBug' (was undefined)


  • extends is Ext.util.BasicFilter (was Ext.Base)

  • Removed Configs

    • disabled
    • id
    • serializer


  • Removed Configs
    • flushDelay

Ext.util.Positionable (private)

  • extends is Ext.Base (was Ext.Base,Object)


  • Modified Configs
    • ghostTpl
      • value is **
        '<tpl for=".">',
        // eslint-disable-line indent
        * was
        '<tpl for=".">',


  • extends is Ext.Evented (was Ext.Evented,Object)

SDK Totals

  • 1,160 Classes
  • 4,141 Configs
  • 1,403 Properties
  • 71 Static Properties
  • 6,057 Methods
  • 201 Static Methods
  • 876 Events
  • 2,052 Vars
  • 42 Sass Mixins

Ext JS 6.7.0 - Classic Toolkit