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 and inheritance. This is done using the checkboxes at the top of the page. Note that filtering out private members also filters the API class navigation tree.

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 Web Application Manager 6.0.0


Application Deployment and Management

Sencha Web Application Manager allows developers to deploy applications using two different methods.

URL Deployment

The URL deployment model allows developers to simply add the URL of the application to the Sencha Web Application Management Console. This allows users to instantly access existing application without any extra effort on the developer's part. This is a great option for 3rd-party SAAS applications or existing applications that are already deployed to a web-server. However, the URL deployment model makes it difficult to support off-line applications.

Console Deployment

Sencha Web Application Manager supports a new deployment model that allows applications to be pushed directly to Sencha Web Application Clients that have access to them.

From the Sencha Web Application Management Console, Sencha Cmd, or via the Sencha Web Application Manager Admin API, a developer can

  • Package an application
  • Create a version of that application in Sencha Web Application Manager
  • Deploy a version to all users who have access to that application

When an application is deployed, the Sencha Web Application Manager server determines all of the devices that have access to that application. It will then send push notifications to each device informing it of the new application version. Sencha Web Application Client will download the application archive the next time it is launched. Each time the user accesses the application, the contents of the application will be served from Sencha Web Application Client. No network connection is required.

Application Versions

An application can have any number of versions, but only one can be deployed at a time. It is possible to rollback to older versions of an application simply by deploying the desired version.

The archive deployment model provides significant flexibility and agility for application management. Application updates can be managed in real-time and on your schedule.

Note: Archive application deployment is currently supported on Android and iOS clients. Application development via Windows Phone and Desktop clients will be released at a later date.

Optimize Application for Deployment:

Application data is transmitted via archive files and decompressing files takes time. The larger your app, the longer it will take. Here are some tips on reducing your application's footprint.

  • Sencha Web Application Manager makes it easy to deploy multiple applications and connect them with the Invoke API. Instead of deploying one large application, deploy several smaller ones.
  • Do not include large datasets or large binary files in application archive. Instead, use the download API and secure storage API to download necessary application content. By delivering data in this manner, you reduce application size and allow data to persist between version upgrades.
  • Requests to local resources should not include query parameters or other cache busting workarounds. Utilizing these sorts of workarounds will cause the appended parameters to be interpreted as part of the file name.

Prepare Application Archive

  1. Build your application using whatever build tool(s) you use to prepare your application for production.

  2. Create an archive of the built application. Sencha Web Application Client will look for an index.html file, so ensure it exists in the root of the application archive folder. The user will receive an error if an index.html file is not present. All major archive file formats are supported: .zip, .7z, .rar, .tar.gz, .tgz, .bz2.

  3. Use one of the following options to upload the Archive to the Sencha Web Application Manager server and create a new version.

Management Console

The Sencha Web Application Manager console can be used to view and manage application versions in Sencha Web Application Manager.

The Application Panel now displays the version of each deployed.

The Application detail panel includes a versions tab that displays all versions of an application.

Creating a New Application Version

  1. Click the "Create" button to create a new version of your application.

  1. Give the version a name. The name can be any string, but should be unique to your application and meaningful to your users.

  2. Select "Upload archive" from the source drop-down to deploy an archive of the app via the Sencha Web Application Manager server.

Note: The process of uploading the archive then having the Sencha Web Application Manager optimize the archive can take several minutes depending on the size of the archive.

  1. Deploy that version to your users by selecting the version from the list and clicking the "deploy" button at the top of the panel.

  2. Confirm the deployment.

Once confirmed, users with access to the application will be notified of a new version.

Command Line Tool

The latest version of Sencha Cmd now supports deploying directly to Sencha Web Application Manager. You will need to have Sencha Cmd version 5.1.2 or greater installed to have access to the new commands.

  1. Generate an API key to submit the app to the Sencha Web Application Manager server.

  2. Create an API key and secret via the Sencha Web Application Manager admin console. Check out Admin API Intro for more details.

  3. Find the ID of the application you are going to update.

The ID can be found in the URL of the overview panel in the management console: The ID is 123456

The ID can also be found using the Admin API.

  1. Update your application's app.json.

Add a manager object and include your app id, API key, and secret:

Sample Code
"manager": {
      // The Sencha Web Application Manager ID for this application
      "id": 12345,
      // The default Sencha Web Application Manager host.
      "host": "",
      // These may be specified here, but are best specified in your user
      // ~/.sencha/cmd/sencha.cfg file
      "apiKey": "",
      "secret": ""

Note: You may also want to modify the version property in app.json as that will be used for the name of the version.

  1. Save the changes.

Sencha Cmd will automatically archive the application in the build directory.

  1. Run the publish command.

    sencha app publish production

If you are using a different build target change production to whatever build environment you have built.

to specify the version name when publishing and override the app.json version:

Sample Code
sencha config -prop app.version=<version> then app publish

Now that the new version is created, you can deploy the application directly from Cmd or you can login the Management Console and deploy the application from there.

Admin API

If you have a Continuous Integration server, or other automated build process, the Admin API is a great way to integrate Sencha Web Application Manager into your deployment process. New application versions can be created and deployed automatically. If you haven't used the Admin API, check out our getting started guide. Once you are able to make Admin API calls, the Version Service API methods will allow you to manage application versions.

If you are using Sencha Web Application Manager to test your applications, the build server can push new versions of the application to the devices being used by your quality assurance team.

Production deployment can be fully automated using Sencha Web Application Manager's Admin API.

Sencha Web Application Manager 6.0.0

Ext JS
Sencha Test
Sencha Themer
IDE Plugins
Sencha Inspector
Sencha Fiddle

Sencha Test

2.0.0 EA 1.0.3



Sencha Themer

Sencha Themer


5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle