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


top

Ext.event.Event

NPM Package

@extjs/ext-react

Hierarchy

Ext.Base
Ext.event.Event

Summary

Just as Ext.dom.Element wraps around a native DOM node, Ext.event.Event wraps the browser's native event-object normalizing cross-browser differences such as mechanisms to stop event-propagation along with a method to prevent default actions from taking place.

Recognizers

Ext JS includes many default event recognizers to know when a user interacts with the application.

For a full list of default recognizers, and more information, please view the Ext.event.gesture.Recognizer documentation.

This class also provides a set of constants for use with key events. These are useful for determining if a specific key was pressed, and are available both on instances, and as static properties of the class. The following two statements are equivalent:

if (e.getKey() === Ext.event.Event.TAB) {
    // tab key was pressed
}

if (e.getKey() === e.TAB) {
    // tab key was pressed
}
No members found using the current filters

properties

Instance Properties

altKey : Boolean

True if the alt key was down during the event.

angle : Number

The angle of the rotation.

This is only available when the event type is rotate

browserEvent : Event

The raw browser event which this object wraps.

button : Number

Indicates which mouse button caused the event for mouse events, for example mousedown, click, mouseup:

  • 0 for left button.
  • 1 for middle button.
  • 2 for right button.

Note: In IE8 & IE9, the click event does not provide the button.

ctrlKey : Boolean

True if the control key was down during the event. In Mac this will also be true when meta key was down.

currentTarget : HTMLElement

Refers to the element the event handler was attached to, vs the target, which is the actual element that fired the event. For example, if the event bubbles, the target element may be a descendant of the currentTarget, as the event may have been triggered on the target and then bubbled up to the currentTarget where it was handled.

defaultPrevented : Boolean

Indicates whether or not preventDefault() was called on the event.

Defaults to:

false

direction : Number

The direction of the swipe. Available options are:

  • up
  • down
  • left
  • right

This is only available when the event type is swipe

distance : Number

The distance of the event.

This is only available when the event type is swipe and pinch.

duration : Number

The duration of the swipe.

This is only available when the event type is swipe

pageX : Number

The browsers x coordinate of the event. Note: this only works in browsers that support pageX on the native browser event object (pageX is not natively supported in IE9 and earlier). In Ext JS, for a cross browser normalized x-coordinate use getX

pageY : Number

The browsers y coordinate of the event. Note: this only works in browsers that support pageY on the native browser event object (pageY is not natively supported in IE9 and earlier). In Ext JS, for a cross browser normalized y-coordinate use getY

pointerType : String

The pointer type for this event. May be empty if the event was not triggered by a pointer. Current available types are:

  • mouse
  • touch
  • pen

rotation : Number

A amount of rotation, since the start of the event.

This is only available when the event type is rotate

scale : Number

The scape of a pinch event.

This is only available when the event type is pinch

shiftKey : Boolean

True if the shift key was down during the event.

target : HTMLElement

The element that fired this event. For the element whose handlers are currently being processed, i.e. the element that the event handler was attached to, use currentTarget

WHEEL_SCALE : Number

The mouse wheel delta scaling factor. This value depends on browser version and OS and attempts to produce a similar scrolling experience across all platforms and browsers.

To change this value:

 Ext.event.Event.prototype.WHEEL_SCALE = 72;

methods

Instance Methods

startDrag

Initiates a drag gesture in response to this event

Only available when type is 'longpress'. When invoked a dragstart event will be immediately fired at the coordinates of the longpress event. Thereafter drag events will fire in response to movement on the screen without regard to the distance moved.

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