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


top

Ext.util.KeyMap

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.util.KeyMap

Sub-Classes

Ext.util.KeyNav

Summary

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);
         }
     }
 });
No members found using the current filters

configs

Optional Configs

binding : Object / Object[][]

Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects.

Properties

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.

binding : Object / Object[][]

Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects.

Properties

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.

eventName : String

The event to listen for to pick up key events.

Defaults to:

'keydown'

eventName : String

The event to listen for to pick up key events.

Defaults to:

"keydown"

ignoreInputFields : Boolean

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

ignoreInputFields : Boolean

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

priority : Number

The priority to set on this KeyMap's listener. Listeners with a higher priority are fired before those with lower priority.

priority : Number

The priority to set on this KeyMap's listener. Listeners with a higher priority are fired before those with lower priority.

processEvent : Function

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.

Defaults to:

Ext.identityFn

processEvent : Function

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.

processEventScope : Object

The scope (this context) in which the processEvent method is executed.

Defaults to:

this

processEventScope : Object

The scope (this context) in which the processEvent method is executed.

Defaults to:

this

target : Ext.Component / Ext.dom.Element / HTMLElement / String

The object on which to listen for the event specified by the eventName config option.

target : Ext.Component / Ext.dom.Element / HTMLElement / String

The object on which to listen for the event specified by the eventName config option.

properties

Instance Properties

lastKeyEvent : Ext.event.Event

The last key event that this KeyMap handled.

lastKeyEvent : Ext.event.Event

The last key event that this KeyMap handled.

methods

Instance Methods

addBinding ( binding )

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

Parameters

binding :  Object/Object[]

A single KeyMap config or an array of configs. The following config object properties are supported:

key :  String / Array

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.

addBinding ( binding )

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

Parameters

binding :  Object/Object[]

A single KeyMap config or an array of configs. The following config object properties are supported:

key :  String / Array

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.

checkModifiers ( binding, event ) : Boolean
private pri

Check if the modifiers on the event match those on the binding

Parameters

binding :  Object

event :  Ext.event.Event

Returns

:Boolean

True if the event matches the binding

destroy ( removeTarget )

Destroys the KeyMap instance and removes all handlers.

Parameters

removeTarget :  Boolean

True to also remove the target

destroy ( removeTarget )

Destroys the KeyMap instance and removes all handlers.

Parameters

removeTarget :  Boolean

True to also remove the target

disable

Disable this KeyMap

disable

Disable this KeyMap

enable

Enables this KeyMap

enable

Enables this KeyMap

handleTargetEvent ( event )
private pri

Process the event from the target.

Parameters

event :  Ext.event.Event

isEnabled Boolean

Returns true if this KeyMap is enabled

Returns

:Boolean

isEnabled Boolean

Returns true if this KeyMap is enabled

Returns

:Boolean

on ( key, fn, [scope] )

Shorthand for adding a single key listener.

Parameters

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.

on ( key, fn, [scope] )

Shorthand for adding a single key listener.

Parameters

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.

processBinding ( binding, event )
private pri

Process a particular binding and fire the handler if necessary.

Parameters

binding :  Object

The binding information

event :  Ext.event.Event

removeBinding ( binding )

Remove a binding from this KeyMap.

Parameters

binding :  Object

removeBinding ( binding )

Remove a binding from this KeyMap.

Parameters

binding :  Object

setDisabled ( disabled )

Convenience function for setting disabled/enabled by boolean.

Parameters

disabled :  Boolean

setDisabled ( disabled )

Convenience function for setting disabled/enabled by boolean.

Parameters

disabled :  Boolean

un ( key, fn, [scope] )

Shorthand for removing a single key listener.

Parameters

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.

un ( key, fn, [scope] )

Shorthand for removing a single key listener.

Parameters

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.

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

ExtReact 6.7.0