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


top

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.Mixin
Ext.mixin.Selectable
NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.

Summary

Tracks what records are currently selected in a databound widget. This class is mixed in to dataview and all subclasses.

No members found using the current filters

configs

Optional Configs

allowDeselect : Boolean

Allow users to deselect a record in a DataView, List or Grid. Only applicable when the Selectable's mode is 'SINGLE'.

Defaults to:

false

getAllowDeselect : Boolean

Returns the value of allowDeselect

Returns

Boolean

setAllowDeselect (allowDeselect)

Sets the value of allowDeselect

Parameters

allowDeselect :  Boolean

deselectOnContainerClick : Boolean

Set to true to deselect current selection when the container body is clicked.

Defaults to:

true

getDeselectOnContainerClick : Boolean

Returns the value of deselectOnContainerClick

Returns

Boolean

setDeselectOnContainerClick (deselectOnContainerClick)

Sets the value of deselectOnContainerClick

Parameters

deselectOnContainerClick :  Boolean

disableSelection : Boolean

Set to true to disable selection. This configuration will lock the selection model that the DataView uses.

Defaults to:

null

getDisableSelection : Boolean

Returns the value of disableSelection

Returns

Boolean

setDisableSelection (disableSelection)

Sets the value of disableSelection

Parameters

disableSelection :  Boolean

mode : 'SINGLE' / 'SIMPLE' / 'MULTI'

Modes of selection.

Defaults to:

'SINGLE'

getMode : 'SINGLE' / 'SIMPLE' / 'MULTI'

Returns the value of mode

Returns

'SINGLE' / 'SIMPLE' / 'MULTI'

setMode (mode)

Sets the value of mode

Parameters

mode :  'SINGLE' / 'SIMPLE' / 'MULTI'

pruneRemoved : Boolean

Remove records from the selection when they are removed from the store.

Important: When using paging or a Ext.data.BufferedStore, records which are cached in the Store's data collection may be removed from the Store when pages change, or when rows are scrolled out of view. For this reason pruneRemoved should be set to false when using a buffered Store.

Also, when previously pruned pages are returned to the cache, the records objects in the page will be new instances, and will not match the instances in the selection model's collection. For this reason, you MUST ensure that the Model definition's idProperty references a unique key because in this situation, records in the Store have their IDs compared to records in the SelectionModel in order to re-select a record which is scrolled back into view.

Defaults to:

true

getPruneRemoved : Boolean

Returns the value of pruneRemoved

Returns

Boolean

setPruneRemoved (pruneRemoved)

Sets the value of pruneRemoved

Parameters

pruneRemoved :  Boolean

selection : Ext.data.Model

The selected record.

Defaults to:

null

getSelection Ext.data.Model[]

Returns the currently selected records.

Returns

:Ext.data.Model[]

The selected records.

setSelection (selection)

Sets the value of selection

Parameters

selection :  Ext.data.Model

properties

methods

Instance Methods

deselect ( records, suppressEvent )

Deselects the given record(s). If many records are currently selected, it will only deselect those you pass in.

Parameters

records :  Number/Array/Ext.data.Model

The record(s) to deselect. Can also be a number to reference by index.

suppressEvent :  Boolean

If true the deselect event will not be fired.

getSelectionCount Number

Returns the number of selections.

Returns

:Number

hasSelection Boolean

Returns true if there is a selected record.

Returns

:Boolean

isSelected ( record ) : Boolean

Returns true if the specified row is selected.

Parameters

record :  Ext.data.Model/Number

The record or index of the record to check.

Returns

:Boolean

select ( records, keepExisting, suppressEvent )

Adds the given records to the currently selected set.

Parameters

records :  Ext.data.Model/Array/Number

The records to select.

keepExisting :  Boolean

If true, the existing selection will be added to (if not, the old selection is replaced).

suppressEvent :  Boolean

If true, the select event will not be fired.

selectAll ( silent )

Selects all records.

Parameters

silent :  Boolean

true to suppress all select events.

selectRange ( startRecord, endRecord, [keepExisting] )

Selects a range of rows if the selection model Ext.mixin.Selectable#getDisableSelection is not locked. All rows in between startRecord and endRecord are also selected.

Parameters

startRecord :  Number

The index of the first row in the range.

endRecord :  Number

The index of the last row in the range.

keepExisting :  Boolean (optional)

true to retain existing selections.

updateLastFocused ( newRecord, oldRecord )

Sets a record as the last focused record. This does NOT mean that the record has been selected.

Parameters

newRecord :  Ext.data.Record

oldRecord :  Ext.data.Record

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!");
    }
});

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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

Parameters

members :  Object

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

Returns

:Ext.Base

this class

events

selectionchange ( this, records, eOpts )

Fires when a selection changes.

Parameters

this :  Ext.mixin.Selectable

records :  Ext.data.Model[]

The records whose selection has changed.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

ExtReact 6.6.0