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.
Provides searching of Components within Ext.ComponentManager (globally) or a specific Ext.container.Container on the document with a similar syntax to a CSS selector. Returns Array of matching Components, or empty Array.
Components can be retrieved by using their Ext.Component:
componentgridpanelMatching by xtype matches inherited types, so in the following code, the previous field
of any type which inherits from TextField will be found:
prevField = myField.previousNode('textfield');
To match only the exact type, pass the "shallow" flag by adding (true) to xtype
(See Component's isXType method):
prevTextField = myField.previousNode('textfield(true)');
You can search Components by their id or itemId property, prefixed with a #:
#myContainer
Component xtype and id or itemId can be used together to avoid possible
id collisions between Components of different types:
panel#myPanel
When Component's id or xtype contains dots, you can escape them in your selector:
my\.panel#myPanel
Keep in mind that JavaScript treats the backslash character in a special way, so you need to escape it, too, in the actual code:
var myPanel = Ext.ComponentQuery.query('my\\.panel#myPanel');
Components can be found by their relation to other Components. There are several relationship operators, mostly taken from CSS selectors:
E F All descendant Components of E that match FE > F All direct children Components of E that match FE ^ F All parent Components of E that match FExpressions between relationship operators are matched left to right, i.e. leftmost selector is applied first, then if one or more matches are found, relationship operator itself is applied, then next selector expression, etc. It is possible to combine relationship operators in complex selectors:
window[title="Input form"] textfield[name=login] ^ form > button[action=submit]
That selector can be read this way: Find a window with title "Input form", in that
window find a TextField with name "login" at any depth (including subpanels and/or
FieldSets), then find an FormPanel that is a parent of the TextField, and in
that form find a direct child that is a button with custom property action set to
value "submit".
Whitespace on both sides of ^ and > operators is non-significant, i.e. can be
omitted, but usually is used for clarity.
Components can be searched by their object property values (attributes). To do that, use attribute matching expression in square brackets:
component[disabled] - matches any Component that has disabled property with
any truthy (non-empty, not false) value.panel[title="Test"] - matches any Component that has title property set to
"Test". Note that if the value does not contain spaces, the quotes are optional.Attributes can use any of the following operators to compare values:
=, !=, ^=, $=, *=, %=, |= and ~=.
Prefixing the attribute name with an at sign @ means that the property must be
the object's ownProperty, not a property from the prototype chain.
Specifications like [propName] check that the property is a truthy value. To check
that the object has an ownProperty of a certain name, regardless of the value use
the form [?propName].
The specified value is coerced to match the type of the property found in the candidate Component using Ext#coerce.
If you need to find Components by their itemId property, use the #id form; it will
do the same as [itemId=id] but is easier to read.
If you need to include a metacharacter like (, ), [, ], etc., in the query, escape it by prefixing it with a backslash:
var component = Ext.ComponentQuery.query('[myProperty=\\[foo\\]]');
The '=' operator will return the results that exactly match the specified object property (attribute):
Ext.ComponentQuery.query('panel[cls=my-cls]');
Will match the following Component:
Ext.create('Ext.window.Window', {
cls: 'my-cls'
});
But will not match the following Component, because 'my-cls' is one value among others:
Ext.create('Ext.panel.Panel', {
cls: 'foo-cls my-cls bar-cls'
});
You can use the '~=' operator instead, it will return Components with the property that exactly matches one of the whitespace-separated values. This is also true for properties that only have one value:
Ext.ComponentQuery.query('panel[cls~=my-cls]');
Will match both Components:
Ext.create('Ext.panel.Panel', {
cls: 'foo-cls my-cls bar-cls'
});
Ext.create('Ext.window.Window', {
cls: 'my-cls'
});
Generally, '=' operator is more suited for object properties other than CSS classes, while '~=' operator will work best with properties that hold lists of whitespace-separated CSS classes.
The '^=' operator will return Components with specified attribute that start with the passed value:
Ext.ComponentQuery.query('panel[title^=Sales]');
Will match the following Component:
Ext.create('Ext.panel.Panel', {
title: 'Sales estimate for Q4'
});
The '$=' operator will return Components with specified properties that end with the passed value:
Ext.ComponentQuery.query('field[fieldLabel$=name]');
Will match the following Component:
Ext.create('Ext.form.field.Text', {
fieldLabel: 'Enter your name'
});
The '/=' operator will return Components with specified properties that match the passed regular expression:
Ext.ComponentQuery.query('button[action/="edit|save"]');
Will match the following Components with a custom action property:
Ext.create('Ext.button.Button', {
action: 'edit'
});
Ext.create('Ext.button.Button', {
action: 'save'
});
When you need to use meta characters like [], (), etc. in your query, make sure to escape them with back slashes:
Ext.ComponentQuery.query('panel[title="^Sales for Q\\[1-4\\]"]');
The following test will find panels with their ownProperty collapsed being equal to
false. It will not match a collapsed property from the prototype chain.
Ext.ComponentQuery.query('panel[@collapsed=false]');
Member expressions from candidate Components may be tested. If the expression returns a truthy value, the candidate Component will be included in the query:
var disabledFields = myFormPanel.query("{isDisabled()}");
Such expressions are executed in Component's context, and the above expression is similar to running this snippet for every Component in your application:
if (component.isDisabled()) {
matches.push(component);
}
It is important to use only methods that are available in every Component instance
to avoid run time exceptions. If you need to match your Components with a custom
condition formula, you can augment Ext.Component to provide custom matcher that
will return false by default, and override it in your custom classes:
Ext.define('My.Component', {
override: 'Ext.Component',
myMatcher: function() { return false; }
});
Ext.define('My.Panel', {
extend: 'Ext.panel.Panel',
requires: ['My.Component'], // Ensure that Component override is applied
myMatcher: function(selector) {
return selector === 'myPanel';
}
});
After that you can use a selector with your custom matcher to find all instances
of My.Panel:
Ext.ComponentQuery.query("{myMatcher('myPanel')}");
However if you really need to use a custom matcher, you may find it easier to implement a custom Pseudo class instead (see below).
Attribute matchers can be combined to select only Components that match all conditions (logical AND operator):
Ext.ComponentQuery.query('panel[cls~=my-cls][floating=true][title$="sales data"]');
E.g., the query above will match only a Panel-descended Component that has 'my-cls' CSS class and is floating and with a title that ends with "sales data".
Expressions separated with commas will match any Component that satisfies either expression (logical OR operator):
Ext.ComponentQuery.query('field[fieldLabel^=User], field[fieldLabel*=password]');
E.g., the query above will match any field with field label starting with "User", or any field that has "password" in its label.
If you need to include a comma in an attribute matching expression, escape it with a backslash:
Ext.ComponentQuery.query('field[fieldLabel^="User\\, foo"], field[fieldLabel*=password]');
Pseudo classes may be used to filter results in the same way as in Ext.dom.Query. There are five default pseudo classes:
not Negates a selector.first Filters out all except the first matching item for a selector.last Filters out all except the last matching item for a selector.focusable Filters out all except Components which by definition and configuration are
potentially able to recieve focus, regardless of their current statecanfocus Filters out all except Components which are curently able to recieve focus.
That is, they are defined and configured focusable, and they are also visible and enabled.nth-child Filters Components by ordinal position in the selection.scrollable Filters out all except Components which are scrollable.visible Filters out hidden Components. May test deep visibility using ':visible(true)'These pseudo classes can be used with other matchers or without them:
// Select first direct child button in any panel
Ext.ComponentQuery.query('panel > button:first');
// Select last field in Profile form
Ext.ComponentQuery.query('form[title=Profile] field:last');
// Find first focusable Component in a panel and focus it
panel.down(':canfocus').focus();
// Select any field that is not hidden in a form
form.query('field:not(hiddenfield)');
// Find last scrollable Component and reset its scroll positions.
tabpanel.down(':scrollable[hideMode=display]:last').getScrollable().scrollTo(0, 0);
Pseudo class nth-child can be used to find any child Component by its
position relative to its siblings. This class' handler takes one argument
that specifies the selection formula as Xn or Xn+Y:
// Find every odd field in a form
form.query('field:nth-child(2n+1)'); // or use shortcut: :nth-child(odd)
// Find every even field in a form
form.query('field:nth-child(2n)'); // or use shortcut: :nth-child(even)
// Find every 3rd field in a form
form.query('field:nth-child(3n)');
Pseudo classes can be combined to further filter the results, e.g., in the form example above we can modify the query to exclude hidden fields:
// Find every 3rd non-hidden field in a form
form.query('field:not(hiddenfield):nth-child(3n)');
Note that when combining pseudo classes, whitespace is significant, i.e.
there should be no spaces between pseudo classes. This is a common mistake;
if you accidentally type a space between field and :not, the query
will not return any result because it will mean "find field's children
Components that are not hidden fields...".
It is possible to define your own custom pseudo classes. In fact, a
pseudo class is just a property in Ext.ComponentQuery.pseudos object
that defines pseudo class name (property name) and pseudo class handler
(property value):
// Function receives array and returns a filtered array.
Ext.ComponentQuery.pseudos.invalid = function(items) {
var i = 0, l = items.length, c, result = [];
for (; i < l; i++) {
if (!(c = items[i]).isValid()) {
result.push(c);
}
}
return result;
};
var invalidFields = myFormPanel.query('field:invalid');
if (invalidFields.length) {
invalidFields[0].getEl().scrollIntoView(myFormPanel.body);
for (var i = 0, l = invalidFields.length; i < l; i++) {
invalidFields[i].getEl().frame("red");
}
}
Pseudo class handlers can be even more flexible, with a selector argument used to define the logic:
// Handler receives array of itmes and selector in parentheses
Ext.ComponentQuery.pseudos.titleRegex = function(components, selector) {
var i = 0, l = components.length, c, result = [], regex = new RegExp(selector);
for (; i < l; i++) {
c = components[i];
if (c.title && regex.test(c.title)) {
result.push(c);
}
}
return result;
}
var salesTabs = tabPanel.query('panel:titleRegex("sales\\s+for\\s+201[123]")');
Be careful when using custom pseudo classes with MVC Controllers: when
you use a pseudo class in Controller's control or listen component
selectors, the pseudo class' handler function will be called very often
and may slow down your application significantly. A good rule of thumb
is to always specify Component xtype with the pseudo class so that the
handlers are only called on Components that you need, and try to make
the condition checks as cheap in terms of execution time as possible.
Note how in the example above, handler function checks that Component
has a title first, before running regex test on it.
Queries return an array of Components. Here are some example queries:
// retrieve all Ext.Panels in the document by xtype
var panelsArray = Ext.ComponentQuery.query('panel');
// retrieve all Ext.Panels within the container with an id myCt
var panelsWithinmyCt = Ext.ComponentQuery.query('#myCt panel');
// retrieve all direct children which are Ext.Panels within myCt
var directChildPanel = Ext.ComponentQuery.query('#myCt > panel');
// retrieve all grids or trees
var gridsAndTrees = Ext.ComponentQuery.query('gridpanel, treepanel');
// Focus first Component
myFormPanel.child(':canfocus').focus();
// Retrieve every odd text field in a form
myFormPanel.query('textfield:nth-child(odd)');
// Retrieve every even field in a form, excluding hidden fields
myFormPanel.query('field:not(hiddenfield):nth-child(even)');
// Retrieve every scrollable in a tabpanel
tabpanel.query(':scrollable');
For easy access to queries based from a particular Container see the Ext.container.Container#query, Ext.container.Container#down and Ext.container.Container#child methods. Also see Ext.Component#up.
Tests whether the passed Component matches the selector string. An empty selector will always match.
component : Ext.Component
The Component to test
selector : String
The selector string to test against.
root : Ext.Component (optional)
The root component.
Defaults to: null
True if the Component matches the selector.
Returns an array of matched Components from within the passed root object.
This method filters returned Components in a similar way to how CSS selector based DOM queries work using a textual selector string.
See class summary for details.
selector : String
The selector string to filter returned Components.
root : Ext.Container (optional)
The Container within which to perform the query. If omitted, all Components within the document are included in the search.
This parameter may also be an array of Components to filter according to the selector.
The matched Components.
Traverses the tree rooted at the passed root in post-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node after being called on its children).
For an object to be queryable, it must implement the getRefItems method which returns all
immediate child items.
This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.
If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.
selector : Object
A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.
root : String
The root queryable object to start from.
fn : Function
The function to call. Return false to abort the traverse.
node : Object
The node being visited.
scope : Object (optional)
The context (this reference) in which the function is executed.
extraArgs : Array (optional)
A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.
Traverses the tree rooted at the passed root in pre-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node before being called on its children).
For an object to be queryable, it must implement the getRefItems method which returns all
immediate child items.
This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.
If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.
selector : Object
A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.
root : String
The root queryable object to start from.
fn : Function
The function to call. Return false to abort the traverse.
node : Object
The node being visited.
scope : Object (optional)
The context (this reference) in which the function is executed.
extraArgs : Array (optional)
A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.
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).
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 | Terms of Use