Ext JS 4.2 to 5
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.
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.
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.
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
- 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.
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.
With this release of Ext JS, we have worked hard to minimize the impact of changes on existing code, but in some situations this was not completely achievable. This guide walks through the most important changes and their potential impact on Ext JS 5.0 applications.
We have removed the top-level "ext*.js" files from the distribution. These files were of limited use in Ext JS 5 and were only preserved for testing and debugging the examples using the dynamic loader. Because Ext JS 5 is a Sencha Cmd Package, its build content has always been in the "build" sub-folder, but the presence of these stubs in the root has generally created confusion for those familiar with previous releases.
You can run the examples in their built, optimized form from the "build/examples" folder.
To restore these stubs, you can run this command from the root folder of the extracted archive:
sencha ant bootstrap
As mentioned in What's New in Ext JS 5.1, Ext JS 5.1
still has two Observable classes (Ext.mixin.Observable, and Ext.util.Observable), but
their API differences have been eliminated. There is only one exception:
Ext.mixin.Observable calls initConfig in its constructor whereas Ext.util.Observable
uses the legacy Ext.apply approach to copy config object properties onto the instance.
We recommend that applications use Ext.mixin.Observable going forward, but we will
continue to support Ext.util.Observable for the foreseeable future since many classes
internal to the framework and in user code depend upon its behavior.
In the past the two Observables offered two different approaches to sorting listeners that needed to be run in a specific order. Ext.util.Observable used a numeric "priority" option to sort the listeners, while Ext.mixin.Observable used the “order” option which only had 3 possible values - “before”, “after”, and “current” (the default). Since “priority is the more flexible of the two, we are standardizing on it going forward, but the “order” option is still supported for compatibility reasons. Along with this change we have deprecated several convenience methods for adding a listener with a particular order:
As part of the API unification process, each Observable class gains some features that were previously only available in the other Observable.
Ext.util.Observable gains the following features:
Auto-managed listeners - When calling on(), if a scope is provided, and that scope is an Observable instance, the listener will automatically become a "managed" listener. This means simply that when the scope object is destroyed, the listener will automatically be removed. This eliminates the need to use the mon() method in a majority of cases since the managing observable and the scope are typically the same object.
The fireAction method - Fires the specified event with the passed parameters and executes a function
The "order" option
The "args" option
Ext.mixin.Observable gains the following features
Class-level observability - allows entire classes of objects to be observed via the static observe() method
The "priority" event option
In Ext JS 5.0, component plugins are automatically destroyed when the component is destroyed. This safety enhancement ensures that all plugins are cleaned up with their component but this can conflict with plugins written for previous versions of the framework have their own handling of component destroy. This is more prominent in Ext JS 5.1 due to the above merging of Observables and how listeners are auto-managed. The resolution is to remove any listeners for "destroy" events and instead rely on the destroy method being called by the component.
Prior to Ext JS 5.1, a two-way binding to a formula would not always write the value back as expected. Consider the following fiddle:
The ViewModel has a formula:
Ext.define('App.view.FooModel', {
extend: 'Ext.app.ViewModel',
alias: 'viewmodel.foo',
formulas: {
x2: {
get: function (getter) {
return getter('x') * 2;
},
set: function (value) {
this.set('x', value / 2);
}
}
}
});
The "x2" property in the above ViewModel is defined as "twice the value of 'x'". The view that is created has a child component with its own ViewModel:
Ext.define('App.view.Foo', {
extend: 'Ext.panel.Panel',
viewModel: {
type: 'foo',
data: {
x: 10
}
},
bind: {
title: 'Formula: {x2} = 2 * {x}'
},
items: [{
xtype: 'numberfield',
viewModel: {
data: {
label: 'Something'
}
},
bind: {
value: '{x2}',
fieldLabel: '{label}'
}
}]
});
In this contrived example, we have two components each with their own ViewModel. Initially, the value of x was delivered to the formula and then x2 was delivered to the numberfield. When the number was increased, however, the value of x2 was simply written to the child's ViewModel.
This behavior is consistent with the fact that ViewModel data is based on the JavaScript prototype chain, but was at odds with the goal of formulas. In Ext JS 5.1, writes to a formula will properly "climb" to the ViewModel with the formula defined and perform the set at that level.
move EventThe Ext.container.Container move event to indicate that a child component has had the
index moved has been renamed to childmove. This resolves the conflict between this
event and the Ext.Component move event.
select EventThe Ext.form.field.ComboBox select event had an inconsistency where the records
parameter would be passed as a single record in some cases or an array of records in
others. This has now been corrected. The default behavior is to provide a array of
records only when using multiSelect:true. The documentation for the event has been
updated to reflect this.
Due to conflicts with built-in focus treatment introduced in Ext JS 5.0.1, Ext.FocusManager has been removed.
For more details regarding accessibility, focus, and keyboard navigation improvements, see the Accessibility Guide.
Ext.menu.MenuManager no longer registers all Menus within your application. To access Menus in a global manner use Ext.ComponentQuery.
The axis rangechange event listener signature changed to include a missing parameter:
the axis itself, which is now the first parameter, e.g.:
listeners: {
rangechange: function (axis, range) {
...
The Ext.data.proxy.Sql class has been removed for Ext JS 5.1 but will be restored in a future release. This class was not planned to be in Ext JS 5.0 but was accidentally included during the merge of Sencha Touch and Ext JS data packages. Apologies for the inconvenience.
Ext JS | Terms of Use