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.
A collection of useful static methods to deal with strings.
Adds a set of character entity definitions to the set used by Ext.String#htmlEncode and Ext.String#htmlDecode.
This object should be keyed by the entity name sequence, with the value being the textual representation of the entity.
Ext.String.addCharacterEntities({
'Ü':'Ü',
'ç':'ç',
'ñ':'ñ',
'è':'è'
});
var s = Ext.String.htmlEncode("A string with entities: èÜçñ");
Note: the values of the character entities defined on this object are expected to be single character values. As such, the actual values represented by the characters are sensitive to the character encoding of the JavaScript source file when defined in string literal form. Script tags referencing server resources with character entities must ensure that the 'charset' attribute of the script node is consistent with the actual character encoding of the server resource.
The set of character entities may be reset back to the default state by using the Ext.String#resetCharacterEntities method
newEntities : Object
The set of character entities to add to the current definitions.
Capitalize the first letter of the given string.
string : String
Creates a RegExp given a string value and optional flags. For example, the
following two regular expressions are equivalent.
var regex1 = Ext.String.createRegex('hello');
var regex2 = /^hello$/i;
The following two regular expressions are also equivalent:
var regex1 = Ext.String.createRegex('world', false, false, false);
var regex2 = /world/;
Available since: 5.0.0
value : String/RegExp
The String to convert to a RegExp.
startsWith : Boolean (optional)
Pass false to allow a match to start
anywhere in the string. By default the value will match only at the start
of the string.
Defaults to: true
endsWith : Boolean (optional)
Pass false to allow the match to end before
the end of the string. By default the value will match only at the end of the
string.
Defaults to: true
ignoreCase : Boolean (optional)
Pass false to make the RegExp case
sensitive (removes the 'i' flag).
Defaults to: true
Converts a string of characters into a legal, parse-able JavaScript var name as long as the passed
string contains at least one alphabetic character. Non alphanumeric characters, and leading non alphabetic
characters will be removed.
s : String
A string to be converted into a var name.
A legal JavaScript var name.
Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.
value : String
The string to truncate.
length : Number
The maximum length to allow before truncating.
word : Boolean (optional)
true to try to find a common word break.
Defaults to: false
The converted text.
Checks if a string ends with a substring
s : String
The original string
end : String
The substring to check
ignoreCase : Boolean (optional)
True to ignore the case in the comparison
Defaults to: false
Escapes the passed string for ' and .
string : String
The string to escape.
The escaped string.
Escapes the passed string for use in a regular expression.
string : String
The string to escape.
The escaped string.
Creates a string created by using the specified sequence of code points.
codePoint : Number...
Codepoints from which to build the string.
A string built from the sequence of code points passed.
Checks if a string has values needing to be html encoded.
s : String
The string to test
true if the string contains HTML characters
Convert certain characters (&, <, >, ', and ") from their HTML character equivalents.
value : String
The string to decode.
The decoded text.
Convert certain characters (&, <, >, ', and ") to their HTML character equivalents for literal display in web pages.
value : String
The string to encode.
The encoded text.
Inserts a substring into a string.
s : String
The original string.
value : String
The substring to insert.
index : Number
The index to insert the substring. Negative indexes will insert from the end of the string. Example:
Ext.String.insert("abcdefg", "h", -1); // abcdefhg
The value with the inserted substring
Pads the left side of a string with a specified character. This is especially useful for normalizing number and date strings. Example usage:
var s = Ext.String.leftPad('123', 5, '0');
// s now contains the string: '00123'
string : String
The original string.
size : Number
The total length of the output string.
character : String (optional)
The character with which to pad the original string.
Defaults to: ' '
The padded string.
Returns a string with a specified number of repetitions a given string pattern. The pattern be separated by a different string.
var s = Ext.String.repeat('---', 4); // = '------------'
var t = Ext.String.repeat('--', 3, '/'); // = '--/--/--'
pattern : String
The pattern to repeat.
count : Number
The number of times to repeat the pattern (may be 0).
sep : String
An option string to separate each pattern.
Resets the set of character entity definitions used by Ext.String#htmlEncode and Ext.String#htmlDecode back to the default state.
Splits a string of space separated words into an array, trimming as needed. If the words are already an array, it is returned.
words : String/Array
Checks if a string starts with a substring
s : String
The original string
start : String
The substring to check
ignoreCase : Boolean (optional)
True to ignore the case in the comparison
Defaults to: false
Utility function that allows you to easily switch a string between two alternating values. The passed value is compared to the current string, and if they are equal, the other value that was passed in is returned. If they are already different, the first value passed in is returned. Note that this method returns the new value but does not change the current string.
// alternate sort directions
sort = Ext.String.toggle(sort, 'ASC', 'DESC');
// instead of conditional logic:
sort = (sort === 'ASC' ? 'DESC' : 'ASC');
string : String
The current string.
value : String
The value to compare to the current string.
other : String
The new value to use if the string already equals the first value passed in.
The new value.
Trims whitespace from either end of a string, leaving spaces within the string intact. Example:
var s = ' foo bar ';
alert('-' + s + '-'); //alerts "- foo bar -"
alert('-' + Ext.String.trim(s) + '-'); //alerts "-foo bar-"
string : String
The string to trim.
The trimmed string.
Uncapitalize the first letter of a given string.
string : String
Appends content to the query string of a URL, handling logic for whether to place a question mark or ampersand.
url : String
The URL to append to.
string : String
The content to append to the URL.
The resulting URL
ExtReact | Terms of Use