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.



Workspaces in Sencha Cmd

This guide introduces Workspaces in Sencha Cmd. Workspaces are designed to support multiple applications that need to share frameworks, code, styling and resources.


The following guides are recommended reading before proceeding further:

What's a Workspace?

The process for building a large application starts the same as the process for building single-page applications. Once an application expands to require multiple pages, certain common issues arise:

  • Use of a common copies of the Sencha frameworks (Ext JS and/or Sencha Touch).
  • Use of code common across pages.
  • Shared or third-party packages.

To support these, Sencha Cmd defines the concept of a "Workspace". A Workspace is simply a folder that ultimately contains one or more pages, frameworks, packages and other shared code or files. The location of the Workspace root folder should be chosen to facilitate these needs as well as your source control requirements. Any generated applications/pages created in sub-folders of the Workspace folder regardless of their depth are consider to be members of the Workspace.

Though not a requirement, it is typically the case that the Workspace folder is the root folder in a source control repository.

The exact organization of your pages inside your Workspace is not important to Sencha Cmd. For the sake of simplicity, however, the examples in this guide create all pages as immediate sub-folders of the Workspace.

Note on terminology. The term "application" can be confusing because it is overloaded and applies at different scales in different organizations. To Sencha Frameworks, an "application" is a web page. Typically these applications call Ext.application() to launch the appropriate code on page load. If a project requires multiple pages, it is often the case that the entire collection of pages is called an "application". For the sake of these guides, we will use the Sencha Framework understanding that a web page is an application.

Generating a Workspace

To generate a Workspace, use this command:

sencha generate workspace /path/to/workspace

This will create the following structure in the specified folder.

workspace.json          # The JSON descriptor for the workspace.
.sencha/                # Sencha-specific files (e.g. configuration)
    workspace/          # Workspace-specific content (see below)
        sencha.cfg      # Configuration file for Sencha Cmd
        plugin.xml      # Plugin for Sencha Cmd


Configuration is similar to that for applications. The file "app.json" file holds configuration for a single app, while "workspace.json" contains configuration properties for all applications in the Workspace.

Framework Locations

The location of Sencha Ext JS or Sencha Touch (i.e., the "SDK" or "framework") is stored as a configuration property of the Workspace. This allows multiple pages to share this configuration. Different teams will have different preferences on these locations and whether or not the Sencha SDK's are stored in their source control system. The settings discussed below give you control over the location of Sencha SDK's in your Workspace.

By default, a Workspace has both Sencha Ext JS and Sencha Touch SDK's. These properties are set in ".sencha/workspace/sencha.cfg" with the following configurations:


The value of the workspace.dir property is determined by Sencha Cmd and is expanded as needed. In other words, by default, a Workspace contains a copy of the SDK's used by the applications it holds.

Applications reference their framework indirectly using the framework property in their "app.json" file:

"framework": "ext"

Generating Pages

Once you have a Workspace, generating pages ("apps") can be done as before but using the "ext" folder in the workspace:

cd apps
sencha -sdk ../ext generate app NewExtApp new-app

Alternatively, the --ext switch can be used to pick the "ext" framework from the workspace without worrying about its path:

cd apps
sencha generate app --ext NewExtApp new-app

Because the target of these generated pages is in a Workspace, the following structure will be created (which is slightly different than for a single-page app):

workspace.json              # The JSON descriptor for the workspace
.sencha/                    # Sencha-specific files (e.g. configuration)
    workspace/              # Workspace-specific content (see below)
        sencha.cfg          # Workspace's configuration file for Sencha Cmd
        plugin.xml          # Workspace plugin for Sencha Cmd

ext/                        # A copy of the Ext JS SDK

touch/                      # A copy of the Sencha Touch SDK

    .sencha/                # Sencha-specific files (e.g. configuration)
        app/                # Application-specific content
            sencha.cfg      # Application's configuration file for Sencha Cmd
    app.json                # The JSON descriptor for the application

    .sencha/                # Sencha-specific files (e.g. configuration)
        app/                # Application-specific content
            sencha.cfg      # Configuration file for Sencha Cmd
    app.json                # The JSON descriptor for the application

build/                      # The folder where build output is placed.
    production/             # Build output for production
    testing/                # Build output for testing

To generate more pages, repeat the above command.

Building Applications

The process for building applications is no different with one or many. Change directories to the application's root folder and run:

sencha app build

For efficiency, you can create a script for this process.


Sencha Cmd provides a powerful package management subsystem that can be used to download and integrate packages of JavaScript, styling and resources into your applications.

workspace.json      # The JSON descriptor for the workspace
    packages/       # Container folder for shared Cmd packages
        local/      # Folder for packages generated in this workspace
        remote/     # Folder for packages downloaded into the workspace

Typically, the "packages/remote" folder will be marked as ignored by source control since these packages can always be downloaded and extracted again from the package repository.

Note: In previous releases, all packages were placed in the "packages" folder. This separation, while helpful in most cases, can be changed in "workspace.json".

Next Steps

The following guides are recommended reading before proceeding further: