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


top

NPM Package

@sencha/ext-react

Hierarchy

Ext.drag.Info

Summary

This class is used to unify information for a specific drag instance. This object is passed to template methods and events to obtain details about the current operation.

It is not expected that this class will be created by user code.

No members found using the current filters

properties

Instance Properties

cursor : Object

Information about the cursor position. Not available when isNative is true.

Properties

current : Object

The current cursor position.

x :  Number

The current x position.

y :  Number

The current y position.

delta : Object

The change in cursor position.

x :  Number

The change in x position.

y :  Number

The change in y position.

initial : Object

The intial cursor position.

x :  Number

The initial x position.

y :  Number

The initial y position.

offset : Object

The offset from the cursor to the top/left of the element.

x :  Number

The x offset.

y :  Number

The y offset.

element : Object

Information about the Ext.drag.Source#element position. Not available when isNative is true.

Properties

current : Object

The current element position.

x :  Number

The current x position.

y :  Number

The current y position.

delta : Object

The change in element position.

x :  Number

The change in x position.

y :  Number

The change in y position.

initial : Object

The intial element position.

x :  Number

The initial x position.

y :  Number

The initial y position.

eventTarget : HTMLElement

The event target that the drag started on.

Not available when isNative is true.

files : FileList

A list of files included for this drag. See: https://developer.mozilla.org/en/docs/Web/API/FileList

Only available when isNative is true.

isNative : Boolean

true if the drag is a native drag event, for example a file draggedi nto the browser.

Defaults to:

false

proxy : Object

Information about the Ext.drag.Source#proxy position. This may be the actual Ext.drag.Source#element. Not available when isNative is true.

Properties

current : Object

The current proxy position.

x :  Number

The current x position.

y :  Number

The current y position.

delta : Object

The change in proxy position.

x :  Number

The change in x position.

y :  Number

The change in y position.

initial : Object

The intial proxy position.

x :  Number

The initial x position.

y :  Number

The initial y position.

element : Ext.dom.Element

The proxy element.

isElement : Boolean

true if the proxy is the Ext.drag.Source#element.

isUnderCursor : Boolean

true if the alignment causes the proxy to be under the cursor.

source : Ext.drag.Source

The drag source. Not available when isNative is true.

target : Ext.drag.Target

The active target. null if not over a target.

types : String[]

The data types this drag provides. Added via setData.

valid : Boolean

true if the target is valid. See Ext.drag.Target for information about validity. false if there is no target.

Defaults to:

false

methods

Instance Methods

clearData ( type )

Clear the data for a particular type.

Parameters

type :  String

The type.

clone Ext.drag.Info

Create a copy of this object with the current state.

Returns

:Ext.drag.Info

A copy of this object.

getData ( type ) : Ext.Promise

Get data for this drag. This method may only be called once the drop completes.

Parameters

type :  String

The type of data to retrieve. Must be in the types. See also setData.

Returns

:Ext.Promise

The data. If the produced data is not a Ext.Promise, it will be wrapped in one.

setData ( type, value )

Set data for this drag. Multiple types may be registered. Each type will be added to types.

Parameters

type :  String

The type of data being registered.

value :  Object/Function

The value being registered. If a function is provided it will be evaluated if requested when the drop completes. The function should return a value or a Ext.Promise that will produce a value.

ExtReact 6.6.0