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


top

NPM Package

@extjs/ext-react

Hierarchy

Ext.util.Sorter
Ext.util.Grouper

Summary

Represents a grouping of items. The grouper works in a similar fashion as the Ext.util.Sorter except that groups must be able to extract a value by which all items in the group can be collected. By default this is derived from the property config but can be customized using the groupFn if necessary.

All items with the same group value compare as equal. If the group values do not compare equally, the sort can be controlled further by setting sortProperty or sorterFn.

No members found using the current filters

configs

Optional Configs

direction : String

The direction to sort by. Valid values are "ASC", and "DESC".

Defaults to:

"ASC"

getDirection : String

Returns the value of direction

Returns

String

setDirection (direction)

Sets the value of direction

Parameters

direction :  String

groupFn : Function

This function is called for each item in the collection to determine the group to which it belongs. By default the property value is used to group items.

Properties

item : Object

The current item from the collection.

return : String

The group identifier for the item.

getGroupFn : Function

Returns the value of groupFn

Returns

Function

setGroupFn (groupFn)

Sets the value of groupFn

Parameters

groupFn :  Function

id : Mixed

An optional id this sorter can be keyed by in Collections. If no id is specified it will use the property name used in this Sorter. If no property is specified, e.g. when adding a custom sorter function we will generate a random id.

getId : Mixed

Returns the value of id

Returns

Mixed

setId (id)

Sets the value of id

Parameters

id :  Mixed

property : String

The field by which records are grouped. Groups are sorted alphabetically by group value as the default. To sort groups by a different property, use the sortProperty configuration.

getProperty : String

Returns the value of property

Returns

String

setProperty (property)

Sets the value of property

Parameters

property :  String

root : String

Optional root property. This is mostly useful when sorting a Store, in which case we set the root to 'data' to make the filter pull the property out of the data object of each item

getRoot : String

Returns the value of root

Returns

String

setRoot (root)

Sets the value of root

Parameters

root :  String

sorterFn : Function

A specific sorter function to execute. Can be passed instead of property. This function should compare the two passed arguments, returning -1, 0 or 1 depending on if item 1 should be sorted before, at the same level, or after item 2.

sorterFn: function(person1, person2) {
    return (person1.age > person2.age) ? 1 : (person1.age === person2.age ? 0 : -1);
}

getSorterFn : Function

Returns the value of sorterFn

Returns

Function

setSorterFn (sorterFn)

Sets the value of sorterFn

Parameters

sorterFn :  Function

sortProperty : String

You can set this configuration if you want the groups to be sorted on something other then the group string returned by the groupFn. This serves the same role as property on a normal Ext.util.Sorter.

getSortProperty : String

Returns the value of sortProperty

Returns

String

setSortProperty (sortProperty)

Sets the value of sortProperty

Parameters

sortProperty :  String

transform : Function

A function that will be run on each value before it is compared in the sorter. The function will receive a single argument, the value.

getTransform : Function

Returns the value of transform

Returns

Function

setTransform (transform)

Sets the value of transform

Parameters

transform :  Function

properties

methods

Instance Methods

createComparator ( sorters, [nextFn] ) : Function

Creates a comparator function (a function that can be passed to Array.sort) given one or more Sorter instances.

The returned function retains a reference to the collection or array of sorters passed. This means the function will produce a comparison based on the current content of the collection or array, and not based on the content at the time of this call.

Parameters

sorters :  Ext.util.Sorter[]/Ext.util.Collection

The Sorter instances.

nextFn :  Object (optional)

The next comparator function to call if all the sorters end with equality.

Returns

:Function

The comparator function.

getGroupString ( item ) : String

Returns the value for grouping to be used.

Parameters

item :  Ext.data.Model

The Model instance

Returns

:String

getState Object

Returns this sorter's state.

Returns

:Object

serialize Object

Returns this sorter's serialized state. This is used when transmitting this sorter to a server.

Returns

:Object

toggle

Toggles the direction of this Sorter. Note that when you call this function, the Collection this Sorter is part of does not get refreshed automatically.

ExtReact 6.5.1