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.
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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
Represents a filter that can be applied to a Ext.util.MixedCollection. Can either simply filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context of MixedCollections, though Ext.data.Stores frequently create them when filtering and searching on their records. Example usage:
// Set up a fictional MixedCollection containing a few people to filter on
var allNames = new Ext.util.MixedCollection();
allNames.addAll([
{ id: 1, name: 'Peter', age: 25 },
{ id: 2, name: 'Egon', age: 37 },
{ id: 3, name: 'Ray', age: 32 },
{ id: 4, name: 'Winston',age: 26 }
]);
var ageFilter = new Ext.util.Filter({
property: 'age',
value : 32
});
var longNameFilter = new Ext.util.Filter({
filterFn: function(item) {
return item.name.length > 4;
}
});
// a new MixedCollection with the 2 names longer than 4 characters
var longNames = allNames.filter(longNameFilter);
// a new MixedCollection with the 1 person of age 32:
var youngFolk = allNames.filter(ageFilter);
True to allow any match - no regex start/end line anchors will be added.
Defaults to:
false
True to make the regex case sensitive (adds 'i' switch to regex).
Defaults to:
false
Setting this property to true disables this individual Filter so that it no longer contributes to a Store's filter set
When disabled, the next time the store is filtered, the Filter plays no part in filtering and records eliminated by it may rejoin the dataset.
Defaults to:
false
true to not have this filter participate in the filtering process when the value of
this the filter is empty according to Ext#isEmpty.
Defaults to:
false
Available since: 5.1.0
Sets the value of disableOnEmpty
disableOnEmpty : Boolean
True to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true.
Defaults to:
false
A custom filter function which is passed each item in the Ext.util.MixedCollection in turn. Should return
true to accept each item or false to reject it.
An identifier by which this Filter is indexed in a Store's filters collection
Identified Filters may be individually removed from a Store's filter set by using Ext.data.Store#removeFilter.
Anonymous Filters may be removed en masse by passing null to Ext.data.Store#removeFilter.
The operator to use to compare the cfg-property to this Filter's cfg-value
Possible values are:
<<==>=>!=innotinlikeThe in and notin operator expects this filter's cfg-value to be an array and matches
values that are present in that array.
The like operator matches values that contain this filter's cfg-value as a
substring.
The '*=' operator uses the cfg-value as the source for a RegExp and tests whether the
candidate value matches the regular expression.
The property to filter on. Required unless a filterFn is passed.
Defaults to:
null
Optional root property. This is mostly useful when filtering 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
Defaults to:
null
The context (this property) in which the filtering function is called. Defaults
to this Filter object.
A function to post-process any serialization. Accepts a filter state object
containing property, value and operator properties, and may either
mutate it, or return a completely new representation. Returning a falsey
value does not modify the representation.
Available since: 6.2.0
Mutation counter which is incremented when the filter changes in ways that mean reevaluation of the filtered state is necessary.
Available since: 6.5.0
Returns this filter's serialized state. This is used when transmitting this filter to a server.
Creates a single filter function which encapsulates the passed Filter array or Collection.
filters : Ext.util.Filter[]/Ext.util.Collection
The filters from which to create a filter function.
A function, which when passed a candidate object returns true
if the candidate passes all the specified Filters.
Checks if two filters have the same properties (Property, Operator and Value).
Available since: 6.2.0
filter1 : Ext.util.Filter
The first filter to be compared
filter2 : Ext.util.Filter
The second filter to be compared
true if they have the same properties.
ExtReact | Terms of Use