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.

ExtReact 6.5.1


NPM Package




This class is a generic implementation of a Style. This should be extended to provide Style implementations for different use cases. Check out Ext.exporter.file.excel.Style and Ext.exporter.file.html.Style.

No members found using the current filters


Optional Configs

alignment : Object

Following keys are allowed on this object and are all optional:

Defaults to:



horizontal : String

Specifies the left-to-right alignment of text within a cell. Possible values: Left, Center, Right, Justify and Automatic.

indent : Number

Specifies the number of indents.

readingOrder : String

Specifies the default right-to-left text entry mode for a cell. Possible values: LeftToRight, RightToLeft and Context.

rotate : Number

Specifies the rotation of the text within the cell.

vertical : String

Specifies the top-to-bottom alignment of text within a cell. Possible values: Top, Bottom, Center and Automatic.

getAlignment : Object

Returns the value of alignment



setAlignment (alignment)

Sets the value of alignment


alignment :  Object

autoGenerateId : Boolean

Set to true to auto generate an id if none is defined.

Defaults to:


getAutoGenerateId : Boolean

Returns the value of autoGenerateId



setAutoGenerateId (autoGenerateId)

Sets the value of autoGenerateId


autoGenerateId :  Boolean

borders : Object[]

Array of border objects. Following keys are allowed for border objects:

Defaults to:



position : String

Specifies which of the possible borders this element represents. Duplicate borders are not permitted and are considered invalid. Possible values: Left, Top, Right, Bottom.

color : String

Specifies the color of this border. This value should be a 6-hexadecimal digit number in "#rrggbb" format.

lineStyle : String

Specifies the appearance of this border. Possible values: None, Continuous, Dash and Dot.

weight : Number

Specifies the weight (or thickness) of this border.

getBorders : Object[]

Returns the value of borders



setBorders (borders)

Sets the value of borders


borders :  Object[]

font : Object

Defines the font attributes to use in this style.

Following keys are allowed on this object:

Defaults to:



bold : Boolean

Specifies the bold state of the font.

color : String

Specifies the color of the font. This value should be a 6-hexadecimal digit number in "#rrggbb" format.

fontName : String

Specifies the name of the font.

italic : Boolean

Similar to font.bold in behavior, this attribute specifies the italic state of the font.

size : Number

Specifies the size of the font.

strikeThrough : Boolean

Similar to font.bold in behavior, this attribute specifies the strike-through state of the font.

underline : String

Specifies the underline state of the font. Possible values: None and Single.

family : String

Font family name.

getFont : Object

Returns the value of font



setFont (font)

Sets the value of font


font :  Object

format : String

This can be one of the following values: General, General Number, General Date, Long Date, Medium Date, Short Date, Long Time, Medium Time, Short Time, Currency, Euro Currency, Fixed, Standard, Percent, Scientific, Yes/No, True/False, or On/Off.

Currency is the currency format with two decimal places.

Euro Currency is the same as Currency using the Euro currency symbol instead.

Defaults to:


getFormat : String

Returns the value of format



setFormat (format)

Sets the value of format


format :  String

id : String

A unique name within the document that identifies this style.

getId : String

Returns the value of id



setId (id)

Sets the value of id


id :  String

interior : Object

Defines the fill properties to use in this style. Each attribute that is specified is considered an override from the default.

Following keys are allowed on this object:

Defaults to:



color : String

Specifies the fill color of the cell. This value should be a 6-hexadecimal digit number in "#rrggbb" format.

pattern : String

Specifies the fill pattern in the cell. Possible values: None, Solid.

getInterior : Object

Returns the value of interior



setInterior (interior)

Sets the value of interior


interior :  Object

name : String

This property identifies this style as a named style.

Defaults to:


getName : String

Returns the value of name



setName (name)

Sets the value of name


name :  String



Instance Methods

checkCollection ( data, dataCollection, className ) : Ext.util.Collection

This method could be used in config appliers that need to initialize a Collection that has items of type className.


data :  Object

dataCollection :  Object

className :  Object



getFormattedValue ( v )

Returns the specified value formatted according to the format of this style.


v :  Object

getRenderData Object

Return the data used when rendering the template



render String

Renders the content according to the template provided to the class


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

ExtReact 6.5.1