Docs Help

Terms, Icons, and Labels

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.

Access Levels

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.

Member Types

Member Syntax

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).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

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.

Class Icons

- 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

Member Icons

- 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

Class Member Quick-Nav Menu

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.

Getter and Setter Methods

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.

History Bar

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.

Search and Filters

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.

API Doc Class Metadata

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:

Expanding and Collapsing Examples and Class Members

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.

Desktop -vs- Mobile View

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:

Viewing the Class Source

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.

Ext JS 7.3.0


top

Release Notes for Ext JS 7.3.1

Fixes

Core

  • EXTJS-26456 - Nested association data from server is considered phantom when no ID is provided
  • EXTJS-17099 - Ext.util.Format.number returns wrong result

Charts

  • EXTJS-26310 - Item highlight is not properly done when tap on charts - touch devices
  • EXTJS-26594 - Pie chart renders incorrectly if there is a zero data point
  • EXTJS-29133 - Toggle series not working for chart DOM legends

Modern

  • EXTJS-29180 - Getting console error when user select Group by this field menu item
  • EXTJS-29178 - Grid View jumping to the left when user click on gray line between two chart rows
  • EXTJS-29158 - Carousel set Items method throws error 'cannot set property owner Cmp of null'
  • EXTJS-29007 - Cannot reload store with grouped grid
  • EXTJS-28961 - Modern locked grid filtering does not filter records
  • EXTJS-27544 - Edge picker animation issues on mobile when required is true
  • EXTJS-26182 - [6.5.1] Grid hideHeaders config is ignored when grid is empty
  • EXTJS-28931 - Row editor not refreshing changed values for non editable columns
  • EXTJS-28873 - Selectionchange event not firing for Modern Dataview
  • EXTJS-28194 - [Modern] 6.5 & 6.6 & 6.7 Doc error
  • EXTJS-27583 - ExtJs 6.6 Modern - icon size
  • EXTJS-26602 - Grid with flex column widths can miscalculate row widths on window resize
  • EXTJS-26561 - Beforeclose, close events are not triggered from a panel inside a tab panel.
  • EXTJS-26371 - Events do not span across days in week view
  • EXTJS-28894 - Edge picker animation issues on mobile when required is true
  • EXTJS-28141 - Localization not working in Modern Toolkit of production build

Classic

  • EXTJS-29155 - Grid features doesn't accept array as documented
  • EXTJS-29109 - Window text is not selectable, html added to body
  • EXTJS-27178 - Form field with allowBlank: false and side msgTarget can cause uncontrollable flicker in field container configuration
  • EXTJS-20055 - Tag field with growmax
  • EXTJS-23565 - Row editor not fully visible when editing a new record on an empty grid
  • EXTJS-23620 - Ext.view.DropZone position indicator left visible when dragging to another DropZone
  • EXTJS-29069 - Combobox custom displayTpl overwritten when displayField changes
  • EXTJS-23149 - Need a setUI alias for the setUI method so that binding to 'ui' will work
  • EXTJS-21875 - Cursor moves from its current field while scrolling when the keyboard is open on iOS

Tooling

  • SDKTOOLS-2085 - Errors in Browser when try to run "sencha app watch --fashion"

Release Notes for Ext JS 7.3.0

Fixes

Core

  • EXTJS-25617 - TreeList should support keyboard navigation
  • EXTJS-18687 - WebStorage proxy does not preserve UUID identifiers when field is not explicitly defined as a type of "string"
  • EXTJS-26228 - VirtualStore fires the same request twice to load a range
  • EXTJS-27586 - Cannot read property 'viewModel' of null

Modern

  • EXTJS-26567 - readOnly property not respected for datePicker, Combobox, checkbox and radio fields
  • EXTJS-28964 - A view with multiples grids is initially unresponsive after rendering
  • EXTJS-27446 - datefield placement on screen in natic iOS build
  • EXTJS-26254 - All edges of resizer are not available with toolbar present in dialog
  • EXTJS-28901 - Grid with infinite stops navigation via up/down buttons in Mobile Safari
  • EXTJS-28185 - [6.7 Modern] Infinite List and Grid get blank when scroll fast on IOS mobile
  • EXTJS-28882 - Virtual keyboard shows/hides switching between fields
  • EXTJS-26392 - Placeholder does not move up when fields autofilled
  • EXTJS-26417 - Cannot escape selectfield focus by tapping "off" input in iOS Safari
  • EXTJS-28724 - Callback event not always called on Modern Ext.Msg.alert
  • EXTJS-28305 - Grid View Jumping when having horizontal scroll
  • EXTJS-26582 - Documentation: Select event for Ext.field.ComboBox in Modern tool kit needs to be changed to record from String.
  • EXTJS-26428 - Picker fields display picker if clicking on unfocused field
  • EXTJS-21161 - Virtual keyboard opens after every tap if user previously tapped in textfield - Edge
  • EXTJS-28364 - In modern toolkit, Selecting different value from dropdown behaviour not working properly
  • EXTJS-28648 - Error when using PullRefresh plugin with Grouped Store

Classic

  • EXTJS-28934 - Widgetcolumn fix working but resulting data display is slow on add/update
  • EXTJS-26552 - white space in grid after scrolling fast
  • EXTJS-28471 - For tree view and simple grid views, an ARIA compatibility checker will report that some [role]s are not contained by their required parent element.
  • EXTJS-23556 - (7.0) Grouped grid - after expand all rows and collapse by ctrl + click, white space remain on top
  • EXTJS-20879 - Tag Field Gives Wrong Suggestion
  • EXTJS-28256 - When using the mouse scroll, the menu items does not scroll in firefox
  • EXTJS-26141 - Locked grid loses selection upon store refresh/reload
  • EXTJS-26005 - Grid focus throws exception removing a row
  • EXTJS-26904 - Scrolling Issue with Buffered Store when scrolling using the mouse wheel
  • EXTJS-23620 - Ext.view.DropZone position indicator left visible when dragging to another DropZone
  • EXTJS-20070 - Button with long text name can display extra padding
  • EXTJS-27485 - Cartesian chart with legend inside a 'Ext.container.Viewport' throws an error in console
  • EXTJS-26280 - Tagfield does not focus to last item selected

Improvement

Core

  • EXTJS-17099 - Ext.util.Format.number returns wrong result
  • EXTJS-27330 - filterByXtype throws an exception when a chart has a legend
  • EXTJS-28945 - Upgrade Froala to Latest in 7.3
  • EXTJS-28939 - Add index to Ext JS classic and modern kitchen sink
  • EXTJS-28942 - Add ready to go templates to examples

Classic

  • EXTJS-28709 - Upgrade the Froala source code, updating it to the latest version at the time of release
  • EXTJS-27845 - When a cell is focused, and scrolled out and back into view buffer, the cell loses focus.
  • EXTJS-28973 - TagField doesn't have initial width (Regression)

Modern

  • EXT-296 - ComboBox needs an EdgePicker
  • EXTJS-28123 - Unable to create a locked grid with checkbox selection

Tooling

  • SDKTOOLS-2097 - Update Sencha Cmd to Support Ext JS 7.3
  • EJUA-19 - Upgrade Adviser and Lint Plugin must support Ext JS 7.3
  • DSGNR-8280 - Update Sencha Architect patch version 4.2.9 for ExtJS 7.3

Ext JS 7.3.0