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


top
Guide applies to: modern

CLI Reference

This guide is a reference of the Open Tooling CLI commands available through ExtGen and its underlying tools.

CLI Tools Description
ext-gen app [...] App generation tool.
ext-gen migrate [...] App dependency migration tool.
ext-build generate [...] Sencha Cmd CLI proxy.

ext-gen app CLI - Application Generation

Ext JS open tooling requires NodeJS and Java.

App Generation CLI Options

Here's a list of the CLI options you could use to generate your application.

Example:

ext-gen app (-h) (-d) (-i) (-t 'template') (-m 'moderntheme') (-c 'classictheme') (-n 'name') (-f 'folder')
CLI Options Alias Description
-h --help show help (no parameters also shows help)
-d --defaults show defaults for package.json
-i --interactive run in interactive mode (question prompts will display)
-t --template name for Ext JS template used for generate
-c --classictheme theme name for Ext JS classic toolkit (not in Community Edition)
-m --moderntheme theme name for Ext JS modern toolkit
-n --name name for Ext JS generated app
-f --folder folder name for Ext JS application (not implemented yet)
-v --verbose verbose npm messages (for problems only)

Available App Templates

There are several app templates to generate your application from. Set the --template property with one of the options below.

Example:

ext-gen app --template universalmodern --moderntheme theme-material --name CoolUniversalApp
Templates Target Platforms Description
classicdesktop Desktop Classic toolkit desktop App template.
classicdesktoplogin Desktop Classic toolkit desktop App with login template.
moderndesktop Dekstop Modern toolkit desktop App template.
moderndesktopminimal Desktop Modern toolkit with simple desktop App template.
 
universalclassicmodern Mobile & Desktop Mobile Modern toolkit & Classic toolkit desktop App template.
universalmodern Mobile & Desktop This is a modern and universal template.

Available Themes

These themes are available in the ext-gen app generation. Set the --classictheme or --moderntheme properties with one of the options below.

Example:

ext-gen app --template universalmodern --moderntheme theme-material --name CoolUniversalApp
Theme Options Available in Toolkit
Modern Toolkit Themes
theme-material Modern Toolkit
theme-ios Modern Toolkit
theme-neptune Modern Toolkit
theme-triton Modern Toolkit
 
Classic Toolkit Themes
theme-classic Classic Toolkit
theme-material Classic Toolkit
theme-neptune Classic Toolkit
theme-neptune-touch Classic Toolkit
theme-crisp Classic Toolkit
theme-crisp-touch Classic Toolkit
theme-triton Classic Toolkit
theme-graphite Classic Toolkit
theme-material Classic Toolkit

ext-gen migrate - Application Migration

ExtGen's migrate command is a helpful utility that will migrate an existing ExtJS application built with Sencha Cmd to an ExtJS application that uses Open Tooling (ExtGen).

ext-gen migrate

Full documentation on ext-gen migrate can be found here.

ext-build CLI

ExtBuild provides Sencha Cmd functionality in Sencha's npm projects. Requires Node and Java.

Installation

  1. Install npm (we assume you have pre-installed node.js).
  2. npm install -g @sencha/ext-build

Usage

CLI Reference

Structure

ext-build generate app (sdk) (template) (name) (path)\ ext-build generate viewpackage (profile) (viewname)

Commands Description
generate, gen, g Create a new application or viewpackage
application, app, a Use with generate command to generate a new application
viewpackage Use with generate command to generate a new viewpackage
migrate Migrating existing Sencha Cmd apps to Open Tooling
CLI Options Description
--builds selected build profile (--builds "desktop:modern,theme-material;phone:modern,theme-material;" is default)
--debug show debugging
--force (deletes application, if present, before generate app (BE CAREFUL WITH THIS!))
--sdk (path to Ext JS sdk - currently required for gen app, no running from sdk folder...)
--template (name of app template to use - only one currently - universalmodern)
profile (name of build profile to generate the viewpackage in)
viewname (name of viewpackage

Examples

// Generate an application, specifying the SDK version and template
ext-build generate app --sdk 'Ext/ext-7.0.0' --template 'universalmodern' MyApp ./MyApp

// Generate an application, specifying the SDK version and template
ext-build gen app -s 'Ext/ext-7.0.0' -t 'universalmodern' MyApp ./MyApp
eb g a -s 'Ext/ext-7.0.0' -t 'universalmodern' MyApp ./MyApp

// Generate a new viewpackage named "settings" for the desktop build profile (configured in app.json) in an existing application
ext-build generate viewpackage desktop settings

// Generate a new viewpackage named "detail" for the phone build profile (configured in app.json) in an existing application
ext-build generate viewpackage phone detail

For Command line help:

ext-build or eb

Driving Sencha Cmd Directly with npx

The feature rich ecosystem many ExtJS users are familiar, Sencha Cmd, is still available in an ExtGen application.

Investigating the @sencha packages inside of your node_modules, you will see Sencha Cmd among other framework packages. Open up the cmd package and you'll find the Sencha Cmd binary. How do you use this binary from your application?

First, if you are familiar with Sencha Cmd you will recall that during installation you probably added Sencha Cmd to your $PATH, wich the binary typically being installed in your user bin directory. An Npm project also has a bin, located at node_modules/.bin. Inside of this folder you will see the binaries made available to your project through npm.

The npm community has created the npx package. Npx will check whether the requested binary is available via your $PATH or if it's available within your project's node_modules/.bin.

To take advantage of old workflows, to or harness additional Sencha horsepower, you can use the npx package + sencha cmd CLI syntax directly from the root of your ExtGen application.

Npx Examples

app watch

// Sencha Cmd
sencha app watch desktop

// Npx + Sencha Cmd
npx sencha app watch desktop

compile

// Sencha Cmd
sencha compile -classpath=js exclude -not -namespace Ext and concat ext-all-dev.js

// Npx + Sencha Cmd
npx sencha compile -classpath=js exclude -not -namespace Ext and concat ext-all-dev.js

Summary

In brief, nearly all of the same Sencha Cmd functionaly you may be previously used to can still be accessed by simply prepending your Sencha Cmd CLI syntax with the npx directive.

Ext JS 7.8.0 - Modern Toolkit