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.
This class manages ready detection and handling. Direct use of this class is not
recommended. Instead use Ext.onReady:
Ext.onReady(function () {
// DOM and Framework are ready...
});
The lowest-level of readiness is DOM readiness. This level implies only that the document
body exists. Many things require the DOM to be ready for manipulation. If that is all
that is required, the Ext.onDocumentReady method can be called to register a callback
to be called as soon as the DOM is ready:
Ext.onDocumentReady(function () {
// the document body is ready
});
In production builds of applications it is common to have all of the code loaded before
DOM ready, so the need to wait for "onReady" is often confused with only that concern.
This is easy to understand, at least in part because historically Ext.onReady only
waited for DOM ready.
With the introduction of Ext.Loader, however, it became common for DOM ready to occur
in the middle of dynamically loading code. If application code were executed at that
time, any use of the yet-to-be-loaded classes would throw errors. As a consequence of
this, the Ext.onReady mechanism was extended to wait for both DOM ready and all of
the required classes to be loaded.
When the framework enters or leaves a state where it is not ready (for example, the
first dynamic load is requested or last load completes), Ext.env.Ready is informed.
For example:
Ext.env.Ready.block();
//...
Ext.env.Ready.unblock();
When there are no blocks and the DOM is ready, the Framework is ready and the "onReady" callbacks are called.
Priority can be used to control the ordering of onReady listeners, for example:
Ext.onReady(function() {
}, null, {
priority: 100
});
Ready listeners with higher priorities will run sooner than those with lower priorities,
the default priority being 0. Internally the framework reserves priorities of 1000
or greater, and -1000 or lesser for onReady handlers that must run before or after
any application code. Applications should stick to using priorities in the -999 - 999
range. The following priorities are currently in use by the framework:
100120001500The number of Framework readiness blocks.
Defaults to:
(location.search || '').indexOf('ext-pauseReadyFire') > 0 ? 1 : 0
This property stores the state of event listeners bound to the document or window to detect ready state.
Defaults to:
0
This allows the DOM listener thread to complete (usually desirable with mobWebkit, Gecko) before firing the entire onReady chain (high stack load on Loader). For mobile devices when running from Home Screen, the splash screen will not disappear until all external resource requests finish. This delay clears the splash screen.
Defaults to:
1
An array of events that have triggered ready state. This is for diagnostic purposes only and is only available in debug builds. An array
Defaults to:
[]
A counter so we can assign listeners an id to keep
them in FIFO order.
Defaults to:
0
A captured value of generation that indicates
when the listeners were last sorted.
Defaults to:
0
Holds the current ready state as managed by this class. The values possible are:
firing.Defaults to:
0
This method starts the process of firing the ready event. This may be delayed based
on the delay property.
This method iterates over the listeners and invokes them. This advances the
state from 1 to 2 and ensure the proper subset of listeners are invoked.
This method is called to schedule a call to handleReady using a setTimeout. It
ensures that only one timer is pending.
delay : Number (optional)
If passed, this overrides the delay property.
This method invokes the given listener instance based on its options.
listener : Object
Invokes as many listeners as are appropriate given the current state. This should
only be called when DOM ready is achieved. The remaining business of blocks is
handled here.
This method wraps the given listener pieces in a proper object for the listeners
array and invoke methods.
fn : Function
The method to call.
scope : Object (optional)
The scope (this reference) in which the fn executes.
Defaults to the browser window.
options : Object (optional)
An object with extra options.
priority : Number (optional)
Relative priority of this callback. A larger number will result in the callback being sorted before the others. Priorities 1000 or greater and -1000 or lesser are reserved for internal framework use only.
Defaults to:
0
dom : Boolean (optional)
Pass true to only wait for DOM ready, false
means full Framework and DOM readiness.
Defaults to:
false
The listener instance.
Adds a listener to be notified when the document is ready (before onload and before images are loaded).
fn : Function
The method to call.
scope : Object (optional)
The scope (this reference) in which the fn executes.
Defaults to the browser window.
options : Object (optional)
An object with extra options.
priority : Number (optional)
Relative priority of this callback. A larger number will result in the callback being sorted before the others. Priorities 1000 or greater and -1000 or lesser are reserved for internal framework use only.
Defaults to:
0
dom : Boolean (optional)
Pass true to only wait for DOM ready, false
means full Framework and DOM readiness.
Defaults to:
false
This is a generic event handler method attached to all of the various events that may indicate ready state. The first call to this method indicates ready state has been achieved.
ev : Event (optional)
The event instance.
This strategy has minimal benefits for Sencha solutions that build themselves (ie. minimal initial page markup). However, progressively-enhanced pages (with image content and/or embedded frames) will benefit the most from it. Browser timer resolution is too poor to ensure a doScroll check more than once on a page loaded with minimal assets (the readystatechange event 'complete' usually beats the doScroll timer on a 'lightly-loaded' initial document).
Sorts the listeners array by phase and priority such that the first listener
to fire can be determined using pop on the listeners array.
a : Object
b : Object
This method is called to remove all event listeners that may have been set up to detect ready state.
ExtWebComponents | Terms of Use