ExtReact Docs Help


The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

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.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

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

Or in the case of an ExtReact component class this indicates a member of type prop

- 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.

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

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.

ExtAngular 6.7.0


Ext.plugin.Responsive alias: plugin.responsive, plugin.responsive deprecated

NPM Package




This class has been deprecated Require Ext.Responsive instead to enable responsiveConfig.


This plugin can be added to component instances to process a responsiveConfig. For example:

     xtype: 'panel',
     layout: 'hbox',

     items: [{
         xtype: 'component',
         plugins: 'responsive',

         responsiveConfig: {
             'width < 800': {
                 hidden: true

             'width >= 800': {
                 hidden: false

For details see responsiveConfig.

No members found using the current filters


Optional Configs

id : String

An identifier for the plugin that can be set at creation time to later retrieve the plugin using the getPlugin method. For example:

 var panel = Ext.create({
     xtype: 'panel',

     plugins: [{
         id: 'foo',

 // later on:
 var plugin = panel.getPlugin('foo');

Available since: 6.2.0

responsiveConfig : Object

This object consists of keys that represent the conditions on which configs will be applied. For example:

 responsiveConfig: {
     landscape: {
         region: 'west'
     portrait: {
         region: 'north'

In this case the keys ("landscape" and "portrait") are the criteria (or "rules") and the object to their right contains the configs that will apply when that rule is true.

These rules can be any valid JavaScript expression but the following values are considered in scope:

  • landscape - True if the device orientation is landscape (always true on desktop devices).
  • portrait - True if the device orientation is portrait (always false on desktop devices).
  • tall - True if width < height regardless of device type.
  • wide - True if width > height regardless of device type.
  • width - The width of the viewport in pixels.
  • height - The height of the viewport in pixels.
  • platform - An object containing various booleans describing the platform (see Ext.platformTags). The properties of this object are also available implicitly (without "platform." prefix) but this sub-object may be useful to resolve ambiguity (for example, if one of the responsiveFormulas overlaps and hides any of these properties). Previous to Ext JS 5.1, the platformTags were only available using this prefix.

A more complex example:

 responsiveConfig: {
     'desktop || width > 800': {
         region: 'west'

     '!(desktop || width > 800)': {
         region: 'north'

NOTE: If multiple rules set a single config (like above), it is important that the rules be mutually exclusive. That is, only one rule should set each config. If multiple rules are actively setting a single config, the order of these (and therefore the config's value) is unspecified.

For a config to participate as a responsiveConfig it must have a "setter" method. In the above example, a "setRegion" method must exist.

Available since: 5.0.0

getResponsiveConfig : Object

Returns the value of responsiveConfig



setResponsiveConfig (responsiveConfig)

Sets the value of responsiveConfig


responsiveConfig :  Object

responsiveFormulas : Object

It is common when using responsiveConfig to have recurring expressions that make for complex configurations. Using responsiveFormulas allows you to cut down on this repetition by adding new properties to the "scope" for the rules in a responsiveConfig.

For example:

 Ext.define('MyApp.view.main.Main', {
     extend: 'Ext.container.Container',

     mixins: [

     responsiveFormulas: {
         small: 'width < 600',

         medium: 'width >= 600 && width < 800',

         large: 'width >= 800',

         tuesday: function (context) {
             return (new Date()).getDay() === 2;

With the above declaration, any responsiveConfig can now use these values like so:

 responsiveConfig: {
     small: {
         hidden: true
     'medium && !tuesday': {
         hidden: false,
         region: 'north'
     large: {
         hidden: false,
         region: 'west'

Available since: 5.0.1

getResponsiveFormulas : Object

Returns the value of responsiveFormulas



setResponsiveFormulas (responsiveFormulas)

Sets the value of responsiveFormulas


responsiveFormulas :  Object



Instance Methods

clonePlugin ( [overrideCfg] )

Creates clone of the plugin.


overrideCfg :  Object (optional)

Additional config for the derived plugin.


The destroy method is invoked by the owning Component at the time the Component is being destroyed.


Plugins that can be disconnected from their host component should implement this method.

Available since: 6.2.0

getCmp Ext.Component

Returns the component to which this plugin is attached.



The owning host component.

init ( host )

The init method is invoked to formally associate the host component and the plugin.

Subclasses should perform initialization and set up any requires links between the plugin and its host Component in their own implementation of this method.


host :  Ext.Component

The host Component which owns this plugin.

setCmp ( host )

Sets the host component to which this plugin is attached. For a plugin to be removable without being destroyed, this method should be provided and be prepared to receive null for the component.


host :  Ext.Component

The owning host component.

Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

    constructor: function() {
        alert("I'm going to be a cat!");



var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");



The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).


members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.



this class

ExtAngular 6.7.0