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 a centralized place for formatting functions. It includes functions to format various different types of data, such as text, dates and numeric values.
This class contains several options for localization. These can be set once the library has loaded, all calls to the functions from that point will use the locale settings that were specified.
Options include:
This class also uses the default date format defined here: Ext.Date#defaultFormat.
There are two helper functions that return a new function that can be used in conjunction with grid renderers:
columns: [{
dataIndex: 'date',
renderer: Ext.util.Format.dateRenderer('Y-m-d')
}, {
dataIndex: 'time',
renderer: Ext.util.Format.numberRenderer('0.000')
}]
Functions that only take a single argument can also be passed directly:
columns: [{
dataIndex: 'cost',
renderer: Ext.util.Format.usMoney
}, {
dataIndex: 'productCode',
renderer: Ext.util.Format.uppercase
}]
XTemplates can also directly use Ext.util.Format functions:
new Ext.XTemplate([
'Date: {startDate:date("Y-m-d")}',
'Cost: {cost:usMoney}'
]);
This may be set to true to make the currency function
append the currency sign to the formatted value.
This may be overridden in a locale file.
Defaults to:
false
The number of decimal places that the currency function displays.
This may be overridden in a locale file.
Defaults to:
2
The currency sign that the currency function displays.
This may be overridden in a locale file.
Defaults to:
"$"
True to add a space between the currency and the value
This may be overridden in a locale file.
Defaults to:
''
Available since: 6.2.0
The character that the number function uses as a decimal point.
This may be overridden in a locale file.
Defaults to:
"."
The percent sign that the percent function displays.
This may be overridden in a locale file.
Defaults to:
"%"
The character that the number function uses as a thousand separator.
This may be overridden in a locale file.
Defaults to:
","
Formats an object of name value properties as HTML element attribute values suitable for using when creating textual markup.
attributes : Object
An object containing the HTML attributes as properties eg: {height:40, vAlign:'top'}
Capitalize the first letter of the given string. Alias for Ext.String#capitalize.
string : String
Format a number as a currency.
value : Number/String
The numeric value to format
sign : String (optional)
The currency sign to use (defaults to currencySign)
decimals : Number (optional)
The number of decimals to use for the currency (defaults to currencyPrecision)
end : Boolean (optional)
True if the currency sign should be at the end of the string (defaults to currencyAtEnd)
currencySpacer : String (optional)
True to add a space between the currency and value
The formatted currency string
Formats the passed date using the specified format pattern. Note that this uses the native Javascript Date.parse() method and is therefore subject to its idiosyncrasies. Most formats assume the local timezone unless specified. One notable exception is 'YYYY-MM-DD' (note the dashes) which is typically interpreted in UTC and can cause date shifting.
value : String/Date
The value to format. Strings must conform to the format expected by the JavaScript Date object's parse() method.
format : String (optional)
Any valid date format string. Defaults to Ext.Date#defaultFormat.
The formatted date string.
Returns a date rendering function that can be reused to apply a date format multiple times efficiently.
format : String
Any valid date format string. Defaults to Ext.Date#defaultFormat.
The date formatting function
Checks a reference and converts it to the default value if it's empty.
value : Object
Reference to check
defaultValue : String (optional)
The value to insert of it's undefined.
Defaults to: ""
Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length. Alias for Ext.String#ellipsis.
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.
Escapes the passed string for ' and . Alias for Ext.String#escape.
string : String
The string to escape.
The escaped string.
Escapes the passed string for use in a regular expression. Alias for Ext.String#escapeRegex.
string : String
The string to escape.
The escaped string.
Simple format for a file size (xxx bytes, xxx KB, xxx MB).
size : Number/String
The numeric value to format
The formatted file size
Returns the given number as a base 16 string at least digits in length. If
the number is fewer digits, 0's are prepended as necessary. If digits is
negative, the absolute value is the exact number of digits to return. In this
case, if then number has more digits, only the least significant digits are
returned.
expect(Ext.util.Format.hex(0x12e4, 2)).toBe('12e4');
expect(Ext.util.Format.hex(0x12e4, -2)).toBe('e4');
expect(Ext.util.Format.hex(0x0e, 2)).toBe('0e');
value : Number
The number to format in hex.
digits : Number
Convert certain characters (&, <, >, ', and ") from their HTML character equivalents. Alias for Ext.String#htmlDecode.
value : String
The string to decode.
The decoded text.
Convert certain characters (&, <, >, ', and ") to their HTML character equivalents for literal display in web pages. Alias for Ext.String#htmlEncode.
value : String
The string to encode.
The encoded text.
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'
Alias for Ext.String#leftPad.
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.
Compares value against threshold and returns:
value < threshold then it returns belowvalue > threshold then it returns abovevalue = threshold then it returns equal or above when equal is missingThe usefulness of this formatter method is in templates. For example:
{foo:lessThanElse(0, 'negative', 'positive')}
{bar:lessThanElse(200, 'lessThan200', 'greaterThan200', 'equalTo200')}
value : Number
Value that will be checked
threshold : Number
Value to compare against
below : Mixed
Value to return when value < threshold
above : Mixed
Value to return when value > threshold. If value = threshold and
equal is missing then above is returned.
equal : Mixed
Value to return when value = threshold
It does simple math for use in a template, for example:
var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}');
A function that operates on the passed value.
Returns a non-breaking space ("NBSP") for any "blank" value.
Available since: 6.2.0
value : Mixed
strict : Boolean (optional)
Pass false to convert all falsey values to an
NBSP. By default, only '', null and undefined will be converted.
Defaults to: true
Converts newline characters to the HTML tag <br/>
v : String
The string value to format.
The string with embedded <br/> tags in place of newlines.
Formats the passed number according to the passed format string.
The number of digits after the decimal separator character specifies the number of decimal places in the resulting string. The local-specific decimal character is used in the result.
The presence of a thousand separator character in the format string specifies that the locale-specific thousand separator (if any) is inserted separating thousand groups.
By default, "," is expected as the thousand separator, and "." is expected as the decimal separator.
Locale-specific characters are always used in the formatted output when inserting thousand and decimal separators. These can be set using the thousandSeparator and decimalSeparator options.
The format string must specify separator characters according to US/UK conventions ("," as the thousand separator, and "." as the decimal separator)
To allow specification of format strings according to local conventions for separator characters, add
the string /i to the end of the format string. This format depends on the thousandSeparator and
decimalSeparator options. For example, if using European style separators, then the format string
can be specified as '0.000,00'. This would be equivalent to using '0,000.00' when using US style formatting.
Examples (123456.789):
0 - (123457) show only digits, no precision0.00 - (123456.79) show only digits, 2 precision0.0000 - (123456.7890) show only digits, 4 precision0,000 - (123,457) show comma and digits, no precision0,000.00 - (123,456.79) show comma and digits, 2 precision0,0.00 - (123,456.79) shortcut method, show comma and digits, 2 precision0.#### - (123,456.789) Allow maximum 4 decimal places, but do not right pad with zeroes0.00## - (123456.789) Show at least 2 decimal places, maximum 4, but do not right pad with zeroesv : Number
The number to format.
formatString : String
The way you would like to format this text.
The formatted number.
Returns a number rendering function that can be reused to apply a number format multiple times efficiently.
format : String
Any valid number format string for number
The number formatting function
Returns this result:
value || orValue
The usefulness of this formatter method is in templates. For example:
{foo:or("bar")}
value : Boolean
The "if" value.
orValue : Mixed
Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result).
box : Number/String
The encoded margins
An object with margin sizes for top, right, bottom and left
Formats the passed number as a percentage according to the passed format string. The number should be between 0 and 1 to represent 0% to 100%.
value : Number
The percentage to format.
The formatted percentage.
If value is a number, returns the argument from that index. For example
var s = Ext.util.Format.pick(2, 'zero', 'one', 'two');
// s === 'two'
Otherwise, value is treated in a truthy/falsey manner like so:
var s = Ext.util.Format.pick(null, 'first', 'second');
// s === 'first'
s = Ext.util.Format.pick({}, 'first', 'second');
// s === 'second'
The usefulness of this formatter method is in templates. For example:
{foo:pick("F","T")}
{bar:pick("first","second","third")}
value : Boolean
The "if" value.
firstValue : Mixed
secondValue : Mixed
Selectively return the plural form of a word based on a numeric value.
For example, the following template would result in "1 Comment". If the
value of count was 0 or greater than 1, the result would be "x Comments".
var tpl = new Ext.XTemplate('{count:plural("Comment")}');
tpl.apply({
count: 1
}); // returns "1 Comment"
Examples using the static plural method call:
Ext.util.Format.plural(2, 'Comment');
// returns "2 Comments"
Ext.util.Format.plural(4, 'person', 'people');
// returns "4 people"
value : Number
The value to compare against
singular : String
The singular form of the word
plural : String (optional)
The plural form of the word (defaults to the singular form with an "s" appended)
output The pluralized output of the passed singular form
Resolves the specified resource url with an optional prefix. This resolution
is based on Ext#resolveResource. The prefix is intended to be used for
a package or resource pool identifier.
url : String
The resource url to resolve
prefix : String (optional)
A prefix/identifier to include in the resolution.
Rounds the passed number to the required decimal precision.
value : Number/String
The numeric value to round.
precision : Number (optional)
The number of decimal places to which to round the
first parameter's value. If undefined the value is passed to Math.round
otherwise the value is returned unmodified.
The rounded value.
Checks if value is a positive or negative number and returns the proper param.
The usefulness of this formatter method is in templates. For example:
{foo:sign("clsNegative","clsPositive")}
value : Number
negative : Mixed
positive : Mixed
zero : Mixed
Strips all script tags.
value : Object
The text from which to strip script tags
The stripped text
Strips all HTML tags.
value : Object
The text from which to strip tags
The stripped text
Returns a substring from within an original string.
value : String
The original text
start : Number
The start index of the substring
length : Number
The length of the substring
The substring
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');
Alias for Ext.String#toggle.
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-"
Alias for Ext.String#trim.
string : String
The string to trim.
The trimmed string.
Uncapitalize the first letter of a given string. Alias for Ext.String#uncapitalize.
string : String
Checks a reference and converts it to empty string if it is undefined.
value : Object
Reference to check
Empty string if converted, otherwise the original value
Converts a string to all upper case letters.
value : String
The text to convert
The converted text
Formats the given value using encodeURI.
Available since: 6.2.0
value : String
The value to encode.
Formats the given value using encodeURIComponent.
Available since: 6.2.0
value : String
The value to encode.
Format a number as US currency.
value : Number/String
The numeric value to format
The formatted currency string
Returns the word at the given index. Spaces and punctuation are considered
as word separators by default. For example:
console.log(Ext.util.Format.word('Hello, my name is Bob.', 2);
// == 'name'
value : String
The sentence to break into words.
index : Number
The 0-based word index.
sep : String/RegExp (optional)
The pattern by which to separate words.
Defaults to: "[\W\s]+"
The requested word or empty string.
ExtReact | Terms of Use