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 and inheritance. 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.

Sencha Cmd 6.x

Guides
API
top

Sencha Cmd 5 Upgrade Guide

This guide is meant to assist developers using Sencha Cmd in migrating from ExtJS 4.1.1a+ to ExtJS 5.0.x. Even though there are some important changes in this release, we have tried to make the upgrade process as painless as possible. Before diving in, it is worth mentioning that this guide makes a few assumptions.

  • Your application was built using Ext JS 4.1.1a+
  • Your application is laid out using our recommended MVC pattern
  • You application is currently building with Sencha Cmd

We recognize that not all of our customers have the luxury of running the latest versions of Ext JS and Sencha Cmd. Time restrictions, deadlines, and support licenses often dictate what version of Ext JS is used in the enterprise.

Taking the time to upgrade to the latest versions of Ext JS 4.x and Cmd 4.x will make the jump into our 5.x branch much smoother. Using the most recent releases ensure that you can utilize many recent bug fixes and avoid significant API changes.

Migration Process

Before You Start

Clean Slate

The first step in the migration process is to make sure you have no changes pending in your source control system. Starting the upgrade while you have other changes in progress is not recommended. This will allow you to much more easily review the changes made by Sencha Cmd so that you are sure any customizations you have made are still in place.

During an upgrade, Sencha Cmd may need to apply changes to some files that you may also have edited. As with any such scenario there is the possibility that you have edited the same lines that Sencha Cmd needs to update creating a merge conflict.

The good news is that, like version control, there are tools that can help resolve these merge conflicts. Sencha Cmd can utilize any visual merge tool that you can run from a command line (which is pretty much all of them). This step is optional, but highly recommended as it will make dealing with upgrade much simpler.

Here is a list of some popular choices (some free, some commercial):

We will configure Sencha Cmd to use your preferred merge tool in the next step.

Upgrade Sencha Cmd

Next, you'll need to grab the latest version of Sencha Cmd 5.

You can download Sencha Cmd 5 or check out the release notes for known issues below:

Release Notes

If you are already using Sencha Cmd 5, you can get the latest beta from our downloads page or run:

sencha upgrade --beta

Install Sencha Cmd and restart your terminal.

Note: If you have a previous version of Cmd installed, this will not replace it, but it will take precedence when running the Cmd software. See above for details.

Configure Merge Tool

If you have chosen to get a merge tool, we need to configure Sencha Cmd to use that merge tool. To do so you need to add two properties to the config file:

cmd.merge.tool
cmd.merge.tool.args

We can set these in the "sencha.cfg" file located in the Sencha Cmd installation folder. Alternatively, these two properties can be set in a version-independent way so your preferences apply to all versions of Sencha Cmd. For details see the end of the "sencha.cfg" file.

App Upgrade

We are ready to start the upgrade. Just run this command from your application's root folder to get things going:

sencha app upgrade -ext    

You should see a very minimal amount of green text letting you know that your application has been successfully upgraded.

In most cases, you will need to perform a build on your application before everything begins working as expected. This can be done by executing the following commanad:

sencha app build

The Microloader

In previous releases of Sencha Cmd, Ext JS applications followed a very different process than did Sencha Touch applications. This was primarily due to the Sencha Touch "microloader". In version Sencha Cmd 4, the microloader moved from Sencha Touch into Sencha Cmd, but at that time the microloader could not run on all the browsers Ext JS supported.

With Sencha Cmd 5 and Ext JS 5, this limitation no longer applies. This means Ext JS 5 applications can now use the same process as Sencha Touch. This opens the doors to some very useful features.

app.json

To take advantage of these, we first need to convert the markup page from the "x-compile" comment form into the microloader script tag and associated "app.json" file. In most cases this will be a simple matter of moving script and CSS references to your "app.json" file. The default markup generated by previous versions of Sencha Cmd looked like this:

<!-- <x-compile> -->
     <!-- <x-bootstrap> -->
         <link rel="stylesheet" href="bootstrap.css">
         <script src="../ext/ext-dev.js"></script>
         <script src="bootstrap.js"></script>
     <!-- </x-bootstrap> -->
     <script src="app.js"></script>
 <!-- </x-compile> -->

The above markup should be changed to this:

<script id="microloader" type="text/javascript" src="bootstrap.js"></script>

The "bootstrap.js" file is generated by Sencha Cmd and is used to load the microloader amongst other things. This file is used only in development mode. The above script tag is replaced as part of the build, much like the "x-compile" block was replaced previously.

The equivalent "app.json" looks like this:

{
    "framework": "ext",
    "css": [
        {
            "path": "bootstrap.css",
            "bootstrap": true
        }
    ],
    "js": [
        {
            "path": "app.js",
            "bundle": true
        }
    ]
}

You may notice there is no js entry to the "ext-dev.js" file. This is because the framework package ("ext") is something Sencha Cmd 5 understands and it will automatically find it in your workspace.

There are many other options you can explore in the "app.json" file. This file gives you easy access to packages (using "requires") and also allows you to pass options into run-time. This is because the content of your "app.json" file will be loaded as Ext.manifest.

Build Properties

In previous versions of Sencha Cmd, many properties had to be specified in ".sencha/app" files. In Sencha Cmd 5, app.json can be used instead in many cases. The content of app.json is flattened into build properties by adding app. and joining property names with ".". For example, these two properties in the app.json:

{
    "theme": "ext-theme-crisp",
    "sass": {
        "namespace": "MyApp"
    }
}

Replace these properties formerly in ".sencha/app/sencha.cfg":

app.theme=ext-theme-crisp
app.sass.namespace=MyApp

There are many other build properties that cannot be specified in app.json (often because they are not app. prefixed), but it is recommended that you stay with only those properties you can control in "app.json" whenever possible. For details on what you can control in app.json refer to that file's comments. For other properties, refer to ".sencha/app/defaults.properties".

Watch

The final step is to either build sencha app build or watch sencha app watch from your application root folder. Either of these will update your application and prepare it for use.

Using watch, you can now view the application on your own web server's localhost or at http://localhost:1841, which is the server we spin up for you automatically. The web server is now a default piece of app watch. In previous releases you had to separately run sencha web start to use the Sencha Cmd web server. You can adjust the web server configuration using these properties (their default values are shown):

build.web.port=1841
build.web.root=${workspace.dir}

With this release, we have optimized watch so that it has a much faster start time and is better at sharing work with Compass while avoiding unnecessary Sass compilations.

Cordova / PhoneGap

If you are using Sencha Cmd's integrated support for Cordova or PhoneGap in your application, then the upgrade process will include a couple extra steps.

Build Profiles

Sencha Cmd 5 added support for defining multiple builds in your app.json file. This support is ideal for native packaging. For Cordova or PhoneGap enabled applications, the "sencha app upgrade" command will add some default build profiles to the top of your app.json file. These build profiles provide a consistent command interface from previous versions of Sencha Cmd as well as show you want more you can accomplish.

The build profiles added by app upgrade for a Cordova application look something like this:

"builds": {
    "web": {
        "default": true
    },

    "native": {
        "packager": "cordova",
        "cordova" : {
            "config": {
                "platforms": "ios",
                ...
            }
        }
    }
},

These build profiles ensure that all of the "sencha app build" command variations are equivalent to previous releases. You will notice, however, that "native" is now a build profile instead of an environment (like "testing" or "production"). This means you can now do "sencha app build native testing" which was previously not possible.

Local Properties Files

New projects generated by Sencha Cmd no longer use "cordova.local.properties" or "phonegap.local.properties". If your application has these files, they will continue to work. New projects should add personal properties (such as PhoneGap Build credentials) to the standard "local.properties" file.

Wrap Up

That is it! Your application is upgraded to the latest Ext JS and Sencha Cmd. After you test things out you can commit the changes (many of them in the ".sencha" folder).

Other Notes

Log Output

If you are familiar with Sencha Cmd, you may have noticed above that Sencha Cmd's console output has been significantly reduced. If you prefer the original logging level, you may re-enable it by add -info to your command. For example:

sencha -info app watch

If you would like less output you can run with -quiet:

sencha -quiet app watch

More Information

For more information about the Upgrade process, please check out these guides:

Sencha Cmd 6.x

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation