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 is used to parse a string into a series of tokens. The syntax of the string is JavaScript-like. This class is useful for creating higher-level parsers to allow them to assemble tokens into a meaningful language (such as bind properties).
The following set of punctuation characters are supported:
+ - * / ! , : [ ] { } ( )
This class does not currently separate the dot operator but instead includes it in a single "ident" token. Whitespace between tokens is skipped.
Tokens are parsed on-demand when next or peek are called. As much as possible,
the returned tokens are reused (e.g., to represent tokens like ":" the same object is
always returned). For tokens that contain values, a new object must be created to
return the value. Even so, the is property that describes the data is a reused object
in all cases.
var tokenizer; // see below for getting instance
for (;;) {
if (!(token = tokenizer.next())) {
// When null is returned, there are no more tokens
break;
}
var is = token.is; // the token's classification object
if (is.error) {
// Once an error is encountered, it will always be returned by
// peek or next. The error is cleared by calling reset().
console.log('Syntax error', token.message);
break;
}
if (is.ident) {
// an identifier...
// use token.value to access the name or dot-path
var t = tokenizer.peek(); // don't consume next token (yet)
if (t && t.is.parenOpen) {
tokenizer.next(); // we'll take this one
parseThingsInParens();
t = tokenizer.next();
mustBeCloseParen(t);
}
}
else if (is.literal) {
// a literal value (null, true/false, string, number)
// use token.value to access the value
}
else if (is.at) {
// @
}
}
For details on the returned token see the peek method.
There is a pool of flyweight instances to reduce memory allocation.
var tokenizer = Ext.parse.Tokenizer.fly('some.thing:foo()');
// use tokenizer (see above)
tokenizer.release(); // returns the fly to the flyweigt pool
The release method returns the flyweight to the pool for later reuse. Failure to call
release will leave the flyweight empty which simply forces the fly method to always
create new instances on each call.
A tokenizer can also be reused by calling its reset method and giving it new text to
tokenize.
this.tokenizer = new Ext.parse.Tokenizer();
// Later...
this.tokenizer.reset('some.thing:foo()');
// use tokenizer (see above)
this.tokenizer.reset();
The final call to reset is optional but will avoid holding large text strings or
parsed results that rae no longer needed.
A map of keywords that should be mapped to other token types. By default the
null, true and false keywords are mapped to their respective literal
value tokens.
Parses and returns the next token from text starting at pos.
The next token
Advance the token stream and return the next token. See peek for a
description of the returned token.
After calling this method, the next call to it or peek will not return the same
token but instead the token that follows the one returned.
The next token in the stream (now consumed).
Parses the current token that starts with the provided character c and
located at the current pos in the text.
c : String
The current character.
The next token
Peeks at the next token stream and returns it. The token remains as the next token
and will be returned again by the next call to this method or next.
At the end of the token stream, the token returned will be null.
If a syntax error is encountered, the returned token will be an Error object. It
has the standard message property and also additional properties to make it more
like a standard token: error: true, type: 'error' and at (the index in the
string where the syntax error started.
The next token in the stream (not yet consumed).
type : String
The type of the token. This will be one of the
following values: ident, literal and error or the text of a operator
(i.e., "@", "!", ",", ":", "[", "]", "{", "}", "(" or ")").
value : String
The value of a "literal" token.
is : Object
An object containing boolean properties based on type.
literal : Boolean
True if the token is a literal value.
boolean : Boolean
True if the token is a literal boolean value.
error : Boolean
True if the token is an error.
ident : Boolean
True if the token is an identifier.
nil : Boolean
True if the token is the null keyword.
number : Boolean
True if the token is a number literal.
string : Boolean
True if the token is a string literal.
operator : Boolean
True if the token is a operator (i.e.,
"@!,:[]{}()"). operators will also have one of these boolean proprieties, in
the respective order: at, bang, comma, colon, arrayOpen, arrayClose,
curlyOpen, curlyClose, parentOpen and parenClose).
Resets the tokenizer for a new string at a given offset (defaults to 0).
text : String
The text to tokenize.
pos : Number (optional)
The character position at which to start.
Defaults to: 0
end : Number (optional)
The index of the first character beyond the token range.
This method is called when a syntax error is encountered. It updates error
and returns the error token.
at : Number
The index of the syntax error (optional).
message : String
The error message.
The error token.
ExtReact | Terms of Use