ExtReact Docs Help

Introduction

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
protected

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.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

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.0 - Modern Toolkit


top
Guide applies to: modern

Using Ext.data.Store Within Flux Apps

ExtReact uses the concept of a store to streamline getting data into and out of several components such as Grid, Tree, and List. Stores in ExtReact should not be confused with the concept of a store in Flux. In Flux, a store is an observable data structure that holds the state of your application. ExtReact stores provide high performance data retrieval, paging, sorting, and filtering for components that display large sets of records.

To illustrate the relationship between these two data structures and how to best connect them, let’s use the popular Redux library as an example.

Consider the following UI, which contains a Grid and a set of search criteria.

When search criteria change, we apply a filter to the grid’s store using the filter method. The store either filters the data in memory, or if a remote proxy is configured, forwards the filter criteria to the server in a fetch request.

There are two possibilities for where an Ext.data.Store should live in an app that uses Redux.

Option 1: In the Redux Store

The Ext.data.Store instance bound to our Grid can reside in the application state stored by Redux. When filter criteria change, we apply a new filter to the store in our reducer:

reducer.js

import { UPDATE_CRITERIA } from './actions';

const initialState = {
    employeesStore: new Ext.data.Store({
        ...
    })
}

export default function reducer(state = initialState, action) {
    switch(action.type) {
        case UPDATE_CRITERIA: 
            const { criteria } = action;
            const filters = []; 

            for (let name in criteria) {
                filters.push({
                    property: name,
                    value: criteria[name]      
                })
            }

            state.employeesStore.filter(filters);
            return { ...state };
    }    
}

In this scenario our Grid component can be implemented as a pure function. We connect it to the redux store using the connect function from react-redux:

EmployeesGrid.js

import React from 'react';
import { Grid } from '@extjs/reactor/modern';    
import { connect } from 'react-redux';

function EmployeesGrid({ store }) {
    return (
        <Grid 
            store={store}
            ...
        />
    )
}

const mapStateToProps = (state) => {
    return { store: state.employeesStore }
};

export default connect(mapStateToProps)(EmployeesGrid);

Redux state is a convenient place for the Ext.data.Store instance for two reasons:

  1. You can easily make the store available to multiple components. For example, you might want to use the same store on both a Grid and a Chart to provide two different views of the same data.

  2. The grid component can be implemented as simple function because all of the logic related to filtering the store resides in our reducer.

This design, however, violates the best practice of making Redux state immutable. Some developers may not be comfortable with this. There are interesting discussions about storing mutable objects within Redux state here and here.

As you might expect opinion is split on the topic. Some developers find this approach to be expedient and have no meaningful side effect, and some prefer their Redux state to remain strictly immutable.

Option 2: In Component State

If we wish to preserve the immutability of our Redux state, we can instead store only the individual criteria in application state, and have our EmployeesGrid component manage the Ext.data.Store using lifecycle methods. With this design our reducer looks like:

reducer.js

import { UPDATE_CRITERIA } from './actions';

const initialState = {
    criteria: { }
}

export default function reducer(state = initialState, action) {
    switch(action.type) {
        case UPDATE_CRITERIA:
            const { criteria } = action;
            return { ...state, criteria };
    }
}

We shift the responsibility for managing our Ext.data.Store to the EmployeesGrid component:

EmployeesGrid.js

import React, { Component } from 'react';
import { Grid } from '@extjs/reactor/modern';
import { connect } from 'react-redux';

class EmployeesGrid extends Component{
    static propTypes = {
        criteria: PropTypes.object
    };

    store = new Ext.data.Store({
        ...
    });

    componentDidUpdate(prevProps) {
        const { criteria } = this.props;

        if (prevProps.criteria !== criteria) {    
            const filters = [];

            for (let name in criteria) {
                filters.push({
                    property: name,
                    value: criteria[name]                   
                })
            }

            this.store.filter(filters)

        }

    }

    render() {
        return (
            <Grid 
                store={this.store}
                ...
            />
        )
    }
}

const mapStateToProps = (state) => {
    return { store: state.employeesStore }
};

export default connect(mapStateToProps)(EmployeesGrid);

This approach has several benefits:

  • Our redux state objects remain immutable, in keeping with the best practice.

  • Our reducer is a pure function, and deals only with plain JS objects.

  • The implementation details of our integration with Ext.data.Store are nicely hidden within our component. In this way, toolkit-specific API calls are confined to the component that needs them (EmployeesGrid).

Conclusion

In our opinion both approaches have their merits, but option #2 (putting Ext.data.Store in component state) is more in keeping with the spirit of Redux. In scenarios where stores need to be accessed by multiple components, such as a grid and a chart, we recommend creating a parent component that contains both and manages the store using lifecycle methods.

You can see a full example of this approach in the extjs-reactor repo.

ExtReact 6.5.0 - Modern Toolkit