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.
Handles mapping key events to handling functions for an element or a Component. One KeyMap can be used for multiple actions.
A KeyMap must be configured with a target as an event source which may be an Element or a Component.
If the target is an element, then the keydown event will trigger the invocation
of bindings.
It is possible to configure the KeyMap with a custom eventName to listen for. This may be useful when the target is a Component.
The KeyMap's event handling requires that the first parameter passed is a key event. So if the Component's event signature is different, specify a processEvent configuration which accepts the event's parameters and returns a key event.
Functions specified in bindings are called with this signature:
(String key, Ext.event.Event e) (if the match is a multi-key combination
the callback will still be called only once). A KeyMap can also handle a string
representation of keys. By default KeyMap starts enabled.
Usage:
// map one key by key code
var map = new Ext.util.KeyMap({
target: "my-element",
key: 13, // or Ext.event.Event.ENTER
handler: myHandler,
scope: myObject
});
// map multiple keys to one action by string
var map = new Ext.util.KeyMap({
target: "my-element",
key: "a\r\n\t",
handler: myHandler,
scope: myObject
});
// map multiple keys to multiple actions by strings and array of codes
var map = new Ext.util.KeyMap({
target: "my-element",
binding: [{
key: [10, 13],
handler: function() {
alert("Return was pressed");
}
}, {
key: "abc",
handler: function() {
alert('a, b or c was pressed');
}
}, {
key: "\t",
ctrl: true,
shift: true,
handler: function() {
alert('Control + shift + tab was pressed.');
}
}]
});
KeyMaps can also bind to Components and process key-based events fired by Components.
To bind to a Component, include the Component event name to listen for, and a processEvent
implementation which returns the key event for further processing by the KeyMap:
var map = new Ext.util.KeyMap({
target: myGridView,
eventName: 'itemkeydown',
processEvent: function(view, record, node, index, event) {
// Load the event with the extra information needed by the mappings
event.view = view;
event.store = view.getStore();
event.record = record;
event.index = index;
return event;
},
binding: {
key: Ext.event.Event.DELETE,
handler: function(keyCode, e) {
e.store.remove(e.record);
// Attempt to select the record that's now in its place
e.view.getSelectionModel().select(e.index);
}
}
});
Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects.
key : String/String[]
A single keycode or an array of keycodes to handle, or
a RegExp which specifies characters to handle, eg /[a-z]/.
shift : Boolean
true to handle key only when shift is pressed, false to handle
the key only when shift is not pressed (defaults to undefined)
ctrl : Boolean
true to handle key only when ctrl is pressed, false to handle
the key only when ctrl is not pressed (defaults to undefined)
alt : Boolean
true to handle key only when alt is pressed, false to handle
the key only when alt is not pressed (defaults to undefined)
handler : Function
The function to call when KeyMap finds the expected key combination
fn : Function
Alias of handler (for backwards-compatibility)
scope : Object
The scope (this context) in which the handler function
is executed.
defaultEventAction : String
A default action to apply to the event
when the handler returns true. Possible values are: stopEvent, stopPropagation,
preventDefault. If no value is set no action is performed.
Configure this as true if there are any input fields within the target,
and this KeyNav should not process events from input fields
(<input>,<textarea> and elements withcontentEditable="true"`)
Defaults to:
false
The priority to set on this KeyMap's listener. Listeners with a higher priority are fired before those with lower priority.
An optional event processor function which accepts the argument list provided by the configured event of the target, and returns a keyEvent for processing by the KeyMap.
This may be useful when the target is a Component with a complex event signature, where the event is not the first parameter. Extra information from the event arguments may be injected into the event for use by the handler functions before returning it.
If null is returned the KeyMap stops processing the event.
The scope (this context) in which the processEvent method is executed.
Defaults to:
this
The object on which to listen for the event specified by the eventName config option.
Add a new binding to this KeyMap.
Usage:
// Create a KeyMap
var map = new Ext.util.KeyMap({
target: Ext.getDoc(),
key: Ext.event.Event.ENTER,
handler: handleKey
});
// Add a new binding to the existing KeyMap later
map.addBinding({
key: 'abc',
shift: true,
handler: handleKey
});
binding : Object/Object[]
A single KeyMap config or an array of configs. The following config object properties are supported:
A single keycode or an array of keycodes to handle,
or a RegExp which specifies characters to handle, eg /[a-z]/.
shift : Boolean
true to handle key only when shift is pressed,
false to handle the key only when shift is not pressed (defaults to undefined).
ctrl : Boolean
true to handle key only when ctrl is pressed,
false to handle the key only when ctrl is not pressed (defaults to undefined).
alt : Boolean
true to handle key only when alt is pressed,
false to handle the key only when alt is not pressed (defaults to undefined).
handler : Function
The function to call when KeyMap finds the expected key combination.
fn : Function
Alias of handler (for backwards-compatibility).
scope : Object
The scope (this context) in which the handler function
is executed.
defaultEventAction : String
A default action to apply to the event
when the handler returns true. Possible values are: stopEvent, stopPropagation,
preventDefault. If no value is set no action is performed.
Destroys the KeyMap instance and removes all handlers.
removeTarget : Boolean
True to also remove the target
Shorthand for adding a single key listener.
key : Number/Number[]/Object
Either the numeric key code, array of key codes
or an object with the following options: {key: (number or array), shift: (true/false),
ctrl: (true/false), alt: (true/false)}
fn : Function
The function to call
scope : Object (optional)
The scope (this reference) in which the function is executed.
Defaults to the browser window.
Remove a binding from this KeyMap.
binding : Object
See for options
Convenience function for setting disabled/enabled by boolean.
disabled : Boolean
Shorthand for removing a single key listener.
key : Number/Number[]/Object
Either the numeric key code, array of key codes
or an object with the following options: {key: (number or array), shift: (true/false),
ctrl: (true/false), alt: (true/false)}
fn : Function
The function to call
scope : Object (optional)
The scope (this reference) in which the function is executed.
Defaults to the browser window.
ExtReact | Terms of Use