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.0.0 - Modern Toolkit


top
Guide applies to: modern

What's New in Ext JS 7.0

Introduction

We’re excited to announce the release of our Sencha Ext JS 7.0 program with major enhancements to the Modern toolkit. The Ext JS 7.0 Modern toolkit supports: drag and drop, row editor and collapsible group for grids, accordion layout, form group, breadcrumb toolbar and drag and drop for tree view. Also localization package has been added to Modern Toolkit. Material Theme is now available for the Classic Toolkit. In addition, Ext JS 7.0 has been upgraded to support Font Awesome 5+, which is SVG based.

Highlights of Ext JS 7.0

New Modern features in this release include:

  • Grid Enhancements - Drag and Drop and Row Editor Plugins, Easily move, reorder or insert content in a grid cell.
  • Collapsible Group, Expand and collapse group of rows in a grid.
  • Tree View Drag and Drop, Easily move and reorder node in a tree view.
  • Accordion Layout, Supports multiple panels and ability to easily expand and collapse.
  • Breadcrumb Toolbar, Easily display hierarchical data Treestore as breadcrumb
  • Form Group, Allows grouping of checkboxes or radio button so that they can be validated or arranged together. For example, if a user does not select at least one value for the checkbox group, then the entire group can be highlighted as invalid.
  • Froala Component, Froala Editor is one of the most beautiful WYSIWYG rich text editor. High performance and simple design make Froala JS text editor easy to use for developer.
  • Localization Package, Addition of localization package to Modern Toolkit so that developers can easily localize applications for non-English users. The locale package includes Dutch, Danish, Italian, Czech, Norwegian, Finnish, Russian, Korean, Japanese and Simplified Chinese.
  • Improved Accessibility, Improved keyboard accessibility, tab-indexing and focusability.

New Classic features in this release include:

  • Material Theme, with its minimalistic look and bold colors is very popular as a design foundation for many applications. Classic toolkit will support Material theme with bold colors, spacing and padding, component depths and shadows and font. It will also use the power of CSS variable and Fashion to allow instant updates.

What’s New in Sencha Ext JS 7.0

Grid Enhancements in Modern Toolkit

Ext JS 7.0 Modern Grid provides drag and drop and row editing, so that end-user can easily move, reorder or insert content in a grid cell.

  1. Drag and Drop plugin - has drag element to move the cursor and grid view node where mouse down event is registered

  2. Row Editor plugin - allows the end user to edit at a row or column level. There will be a button to save or cancel the changes.

A Kitchensink example is provided that show all the capabilities of drag and drop and row editor plugins for Grid.

Collapsible Group

Ext JS 7.0 Modern Grid provides Collapsible Group, so that end-user can expand and collapse groups of rows in a grid. Collapsible Group provides a way to display and organize large dataset and allows end-user to see high level summary of data or drill into specific details from a single grid.

Tree View Drag and Drop

Ext JS 7.0 Modern Tree view provides Drag and Drop plugin so that end-user can move and reorder node in a tree hierarchy easily. The drag zone and drop zone associated with tree view will participate in drag and drop functionality. The drag operation will include properties to specify:

  • Source Tree View from which the drag is originated
  • Drag element which moves the cursor
  • Tree View Node where the mouse down event is registered
  • Selected data dragged from the source tree view

Accordion Layout

Ext JS 7.0 provides Accordian Layout, to support multiple panels layout in an expandable accordion style such that by default only one Panel can be expanded at any given time so that developer can provide the focus on specific panel at one time but add more content on other panels that end-user can explore.

Breadcrumb Toolbar

Ext JS 7.0 Modern Breadcrumb Toolbar, offers a way to easily display hierarchical data treestore as a trail of breadcrumb buttons. Each button represents a node in the store. A click on the button will select that node in the tree. Non-leaf nodes will display their child nodes on a drop-down menu of the corresponding button in the breadcrumb trail.

From Group

Ext JS 7.0 provides Form Group that allows grouping of checkboxes or radio buttons so that they can be validated or arranged together.

Froala Text Editor

Ext JS 7.0 Modern toolkit includes Froala Text Editor as part of the premium package. Froala is one of the most beautiful WYSIWYG high-performing rich text editor with a simple and clean design. Froala Editor will be available as a premium package, which is available as part of the Enterprise license.

Note: To fully deploy the Froala Editor, user will need to obtain a Froala activation key.

Localization Package

Ext JS 7.0 Modern toolkit includes Localization Package so that developers can easily localize applications for non-English users. The locale package includes Dutch, Danish, Italian, Czech, Norwegian, Finnish, Russian, Korean, Japanese and Simplified Chinese.

Enhanced Accessibility for Modern Toolkit

Application Accessibility is an important requirement for enterprise applications and great user experience. Ext JS 7.0 Modern toolkit includes updates for accessibility including keyboard navigation, built-in tab indexing and focus-ability.

Material Theme for Classic Toolkit

Material Theme, a popular theme, is now available for Ext JS 7.0 Classic toolkit. Similar to Modern toolkit, Material Theme in Classic toolkit will use the power of CSS variables and Fashion to dynamically change the colors and look and feel. Note that the Material Theme Ripples may not be supported on older browsers such as IE8, IE 9, IE 10.

Upgrade to version 5+ for Font Awesome

Ext JS 7.0 has been upgraded to support Font Awesome 5+, which is SVG based.

What’s New in Ext JS 7.0 Tooling

ExtGen and Sencha Cmd

ExtGen 7.0 and Sencha Cmd have been updated to support Ext JS 7.0.

Try Ext JS 7.0

Ext JS 7.0.0 - Modern Toolkit