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.
Provides the ability to execute one or more arbitrary tasks in an asynchronous manner.
Generally, you can use the singleton Ext.TaskManager. Or you can create separate TaskRunner instances to start and stop unique tasks independent of one another.
To end a running task:
task.destroy();
If a task needs to be started and stopped repeated over time, you can create a Ext.util.TaskRunner.Task instance.
var runner = new Ext.util.TaskRunner(),
task;
task = runner.newTask({
run: function() {
// useful code
},
interval: 1000
});
task.start();
// ...
task.stop();
// ...
task.start();
A re-usable, single-run task can be managed similar to the above:
var runner = new Ext.util.TaskRunner(),
task;
task = runner.newTask({
run: function() {
// useful code
},
interval: 1000,
repeat: 1
});
task.start();
// ...
task.stop();
// ...
task.start();
See the start method for details about how to configure a Task.
Also see Ext.util.DelayedTask.
This may be configured false to inhibit firing of the idle event after task invocation.
Defaults to:
true
interval : Number/Object (optional)
The minimum precision in milliseconds supported by this TaskRunner instance. Alternatively, a config object to apply to the new instance.
Defaults to: 10
Creates a new Ext.util.TaskRunner.Task instance. These instances can be easily started and stopped.
config : Object
The config object. For details on the supported properties, see start.
Ext.util.TaskRunner.Task instance, which can be useful for method chaining.
Starts a new task.
Before each invocation, Ext injects the property taskRunCount into the task object
so that calculations based on the repeat count can be performed.
The returned task will contain a destroy method that can be used to destroy the
task and cancel further calls. This is equivalent to the stop method.
task : Object
A config object that supports the following properties:
run : Function
The function to execute each time the task is invoked. The
function will be called at each interval and passed the args argument if specified,
and the current invocation count if not.
If a particular scope (this reference) is required, be sure to specify it using
the scope argument.
return : Boolean
false from this function to terminate the task.
onError : Function
The function to execute in case of unhandled error on task.run.
interval : Number
The frequency in milliseconds with which the task should be invoked.
args : Object[] (optional)
An array of arguments to be passed to the function
specified by run. If not specified, the current invocation count is passed.
addCountToArgs : Boolean (optional)
True to add the current invocation count as one of the arguments of args. Note: This only takes effect when args is specified.
Defaults to:
false
scope : Object (optional)
The scope (this reference) in which to execute the
run function. Defaults to the task config object.
duration : Number (optional)
The length of time in milliseconds to invoke the task before stopping automatically (defaults to indefinite).
repeat : Number (optional)
The number of times to invoke the task before stopping automatically (defaults to indefinite).
fireIdleEvent : Number (optional)
If all tasks in a TaskRunner's execution
sweep are configured with fireIdleEvent: false, then the
idleEvent is not fired when the TaskRunner's execution
sweep finishes.
Defaults to:
true
fireOnStart : Boolean (optional)
True to run the task immediately instead of waiting for the interval's initial pass to call the run function.
Defaults to:
false
Stops an existing running task.
task : Object
The task to stop.
andRemove : Boolean
Pass true to also remove the task from the queue.
The task
Stops all tasks that are currently running.
andRemove : Boolean
Pass true to also remove the tasks from the queue.
ExtReact | Terms of Use