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.

ExtWebComponents 7.1.0


NPM Package





This class parses an XML-based AMFX message and returns the deserialized objects. You should not need to use this class directly. It's mostly used by the AMFX Direct implementation. To decode a message, first construct a Decoder:

 decoder = Ext.create('Ext.data.amf.XmlDecoder');

Then ask it to read in the message :

resp = decoder.readAmfxMessage(str);

For more information on working with AMF data please refer to the AMF Guide.

No members found using the current filters


Instance Properties

private pri

Converters used in converting specific typed Flex classes to JavaScript usable form.

Defaults to:

    'flex.messaging.io.ArrayCollection': function(decoder, node) {
        return decoder.convertObjectWithSourceField(node);
    'mx.collections.ArrayList': function(decoder, node) {
        return decoder.convertObjectWithSourceField(node);
    'mx.collections.ArrayCollection': function(decoder, node) {
        return decoder.convertObjectWithSourceField(node);


Instance Methods


Clears the accumulated data and reference tables

constructor ( config )

Creates new encoder.


config :  Object

Configuration options

convertObjectWithSourceField ( node )
private pri

Converts externalizable flex objects with a source array to a regular array.


node :  Object

readAmfxMessage ( xml ) : Object

Reads and returns a decoded AMFX packet.


xml :  String

the xml of the message



the response object containing the message

readArray ( node ) : Array

Parses and returns an AMFX array.


node :  HTMLElement/XMLElement

the array node



the deserialized array

readDictionary ( node ) : Object

Parses and returns an AMFX dictionary.


node :  HTMLElement/XMLElement

the <dictionary> node



a javascript object with the dictionary value-pair elements

readObject ( node ) : Object

Parses and returns an AMFX object.


node :  HTMLElement/XMLElement

the <object> node to parse



the deserialized object

readObjectRef ( node ) : Object

Parses and return an object / array / dictionary / date from reference


node :  HTMLElement/XMLElement

the ref node



the previously instantiated object referred to by the ref node

readString ( node ) : String

Reads a string or string reference and return the value


node :  HTMLElement/XMLElement

the node containing a string object



the parsed string

readTraits ( node ) : Array

Parses and returns an ordered list of trait names


node :  HTMLElement/XMLElement

the traits node from the XML doc



an array of ordered trait names or null if it's an externalizable object

readValue ( node ) : Object

Parses an HTML element returning the appropriate JavaScript value from the AMFX data.


node :  HTMLElement

The node to parse



a JavaScript object or value

Static Methods

decodeTidFromFlexUID ( messageId ) : Number
static sta

Accepts Flex-style UID and decodes the number in the first four bytes (8 hex digits) of data.


messageId :  String

the message ID



the transaction ID

readAMF3Value ( bytes ) : Object
static sta

Deserializes an AMF3 binary object from a byte array


bytes :  Array

the byte array containing one AMF3-encoded value



the decoded value

readByteArray ( node ) : Array
static sta

parses a node containing a byte array in hexadecimal format, returning the reconstructed array.


node :  HTMLElement/XMLElement

the node



a byte array

readXml ( xml )
static sta private pri

Parses an xml string and returns an xml document


xml :  String

ExtWebComponents 7.1.0