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

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.


item :  Object

The config object being added.


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 6.6.0


Ext JS Community Edition

What’s in Ext JS Community Edition

Ext JS core framework to build cross-platform enterprise web apps

The Ext JS Community edition provides you a complete framework with Ext JS core, hundreds of modern components, Material theme, and open tooling to build amazing web applications.

Hundreds of modern components including Modern Grid

Ext JS includes the industry’s most comprehensive collection of pre-integrated and tested high-performance UI components. These components include grids,trees, lists, forms, menus, toolbars, panels, windows, and much more. The Ext JS Grid is one of the most popular components that supports inline cell editing as well as form-based row editing, group headers and selectable config that allows users to select data as they would in Microsoft Excel.

Comprehensive data package to manage massive datasets

The Ext JS Grid includes a virtual store that allows you to create grids and lists that render and scroll through extremely large datasets. The virtual store loads only the pages needed by the grid. When combined with the List component’s infinite config, which is on by default in grids, only a small portion of these loaded records are rendered to the DOM. These optimizations ensure that the browser performs well for the user regardless of the amount of data you are presenting.

Material theme to create beautiful apps

Ext JS components are available with Material as built-in themes. The Material theme is easily customizable to reflect a specific brand identity. Material theme exposes hundreds of variables used by Ext JS, which can be altered to design custom themes.

Open tooling to generate and build your first starter apps

Ext JS open tooling will help you with code generation, build integration and workspace management. ExtGen is a new powerful tool that will help you quickly create new applications using Ext JS npm packages. ExtGen provides multiple new templates to help you build mobile, desktop, and minimal applications. You can also use your own template to create new Ext JS applications.

Support for latest in web technology tools with npm, WebPack and Babel

JavaScript tooling is evolving to create web apps on faster timelines, with improved quality and maintainability. npm is the package manager for JavaScript and the world’s largest software registry, hosting a repository of 700,000+ JavaScript based code packages that developers can use in their applications. Ext JS uses the latest in web technology tooling with Ext JS npm packages, node-based cross-platform command line tooling and Babel-based toolchain to support the latest JavaScript standards. Any applications generated will use the WebPack development server so that any changes to the app will be immediately reflected in the browser.

Access to hosted npm repository

The Ext JS framework, components and themes are available as npm packages hosted in the npm repository. Ext JS developers can execute simple commands to add a package to their project, manage dependencies, and manage versions of packages being used. They can also easily include third-party JavaScript libraries in Ext JS applications.

For example, you can easily add the Ext JS Tree Grid npm package to your project with the following command

npm i --save @sencha/ext-modern-treegrid

Example apps - Tutorial and guides

Ext JS provides a "Quick Start" tutorial that demonstrates how to build a custom music video preview player by drawing public data from the iTunes website, specifically the top videos of latest period rating. Users can build an application that has:

  • A landing page using Ext JS TabPanel component

  • A custom table of videos using a Grid component in Ext JS

  • A collection of custom styled thumbnails using a Dataview component in Ext JS

Each tab allows for the rendering of a 30-second video preview in a hovering modal window using a Dialog component in Ext JS, whether clicking on a thumbnail from the Dataview or a record from the Grid.

Stencils - a complete UI asset toolkit to design your apps

Sencha Stencils is a free complete UI asset kit that works with Ext JS. Stencils are provided for Adobe Illustrator, Sketch, Balsamiq and are also available as SVG/PNG for use with other programs. Stencils contains all of the components and styles used in the Ext JS framework.

Fiddle - online utility for creating, running and sharing Ext JS code examples

Sencha Fiddle provides an online IDE along with a view of your running example without the overhead of setting up a local environment. You can use Sencha Fiddle with Ext JS and try Ext JS code in your browser without downloading or installing anything. You can also easily share your Ext JS code by saving and sharing fiddle URLs.

Ext JS 6.6.0