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 8.1.0


top

What's New in Ext JS 8.1

Introduction

We’re excited to announce the release of Sencha Ext JS 8.1, with updates across both the Modern and Classic toolkits. This release upgrades key third-party packages, including Froala 5.x and the D3 package, and adds developer-requested enhancements to grid cells, the RowExpander plugin, and ComboBox filtering.

Highlights

Froala 5.x Support

The Sencha Froala package now ships with Froala 5.x, using the minified distribution.

Key Aspects:

  • The Froala package is upgraded to the Froala 5.x editor.
  • Uses the minified Froala distribution for a smaller footprint and faster load times.
  • Existing Froala editor configs, events, and methods continue to work through the Sencha wrapper.
  • Applications should review the Froala 5.x release notes for any plugin or option changes.
  • Kitchen Sink Example

D3 Package Upgrade

The D3 package has been upgraded and is now offered as a premium feature.

Key Aspects:

  • Updated to a newer version of the D3 library.
  • Available as a premium feature; a qualifying Ext JS license is required to use the package.
  • Existing D3 components continue to work with Ext JS configs, events, and themes.
  • Kitchen Sink Example

Renderer Support for Date, Boolean, and Text Grid Cells

Ext.grid.cell.Date, Ext.grid.cell.Boolean, and Ext.grid.cell.Text now support the renderer config.

Key Aspects

  • Customize the displayed value of date, boolean, and text cells with a renderer function.
  • Keeps the built-in behavior of each cell type while allowing custom formatting.
  • Removes the need to switch to a generic cell or template just to change output.

RowExpander: Expand or Collapse All Rows on Load

The RowExpander plugin adds a new setting that expands or collapses all rows when the grid loads.

Key Aspects:

  • A single config controls the initial expanded or collapsed state of every row.
  • Removes the need for custom load listeners to toggle each row.
  • Works with existing RowExpander templates and events.
  • Kitchen Sink Example

ComboBox: Case-Insensitive Regular Expression Filtering

When enableRegEx is set, ComboBox filtering no longer has to be case-sensitive.

Key Aspects:

  • Regular expression filtering can now match regardless of letter case.
  • Gives users more forgiving type-ahead search results.
  • Default behavior is unchanged for existing applications.

SDK Version 8.1.0

The SDK version number is updated to 8.1.0.

Key Aspects:

  • Framework packages and Ext.getVersion report 8.1.0.
  • Update app.json and build tooling references to 8.1.0 when upgrading.

Open Tooling / ExtGen

ExtGen and Open Tooling now support Ext JS 8.1.0 and npm 12, and include security updates to third-party libraries.

Key Aspects:

  • Generate and build Ext JS 8.1.0 applications with ExtGen and npm-based Open Tooling.
  • Supports npm 12, the latest major version of npm.
  • Third-party libraries have been updated in both ExtGen and Sencha Cmd.

Ext JS 8.1.0