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


Push Notifications

Sencha Web Application Manager allows an application developer to send push notifications to an application running in Sencha Web Application client. Three types of notifications are supported:

  • An alert that is shown to the user and is actionable
  • A badge that shows a string next to the application name
  • A data string that is received by the application


The overall interaction between the various parties is as follows:

Sencha Web Application Manager Push Notifications Overview

For example, this is how an email application could utilize push notifications inside of Sencha Web Application Manager:

  1. The email application, running in Sencha Web Application Client, collects the application Id and current user email of the Sencha Web Application Manager user.
  2. The application sends the information to a server that has credentials for the Sencha Web Application Manager public API.
  3. When the user receives an email, the server prepares a payload.
    1. Alert for the new email
    2. Badge for the new unread email count
    3. Data for an internal application update
  4. Using the public API, the server sends the payload with the other required information to the Sencha Web Application Manager server.
  5. The Sencha Web Application Manager server forwards the payload to all devices belonging to that user.
  6. The application on one of the devices has the email read by the user.
  7. That application clears the badge on the device.
  8. The new badge value is sent to the Sencha Web Application Manager server, clearing the badge on the other devices owned by the user.

Sencha Web Application Manager Administrator

Sencha Web Application Manager administrator modify push notification access via the API access section of the application's info tab.

Admin API

Appliction notifications

API level access to notifications. This includes local notifications, set application badges, and get notification settings.

Push notifications

This setting allows the client to receive push notifications from the server. If it is disabled, calls to the notification method of the push service in the public API will receive an error.

Push notification settings

This setting allows the client to opt in/out of notification alerts and badges. If Push notifications is disabled, this setting does nothing, as the client will never receive alerts and badges. If Push notifications is enabled and this setting is disabled, users will always receive alerts and badges.


The currently supported method to push notifications to an application is through the public API. The server sends the following information:

  • id - A number to track the response.
  • auth - 'push'
  • method - 'notification'
  • auth - Your authentication token.
  • bookmarkId - The application's id, obtained by the application and Ext.spaceAppId.
  • userEmail (optional) - The user's email target, obtained by the application at the profile API.
  • badge - The application badge.
  • data - A string of data.
  • alert - An alert to show containing the following properties.
    • message - The alert message.
    • icon (optional) - The alert icon. The alert will revert to the application icon if missing.
    • tags (optional) - An array of strings that will be sent to the application with the alert.

Note: The body only needs at least one of alert, data, or badge.

The following post body is an example that shows an alert and sets the application's badge value to 3.

    id: 1,
    auth: 'yourauthtoken',
    service: 'push',
    method: 'notification',
    params: {
        bookmarkId: 1022,
        userEmail: '[email protected]',
        alert: {
            message: 'You have a new message!',
            icon: '',
            tags: ['unread','test']
        badge: '3'

Sencha Web Application Client Application Developer

Here are a few of the APIs available to developers created applications for Sencha Web Application Client. For a complete list, please visit our documentation.

Receiving Events

You can receive events for three different types of notifications: badge, data, and alert.

Application Notifications

The normal way to listen for notifications is using the API. {
    // badge changed
}); {
    // data received
}); {
    // alert received

The badge and data parameters are simple scalar values; the alert object contains:

  • message (string)
  • icon (string)
  • tags (array)

Cross-Application Notifications

You can also receive events for notification that are sent to any installed application in the current organization. Normal applications will not find this useful, but it helps when creating things like administration dashboards., badge) {
    // badge changed
});, data) {
    // data received
});, alert) {
    // alert received

The incoming values are the same as above, with the addition of the application ID associated with each notification.

Get Settings

In order to discover the current notification settings for your application, use the following API call. {
    // check for required setting in the settings object

The settings object contains the following boolean properties:

  • sendPushNotifications - If push notifications are allowed for this application.
  • clientPushNotificationSettings - If client overrides are allowed for this application.
  • userAlerts - The client's alert setting.
  • userBadges - The client's badge setting.

Application Badge

Getting the current badge of the application is available via getBadge(). {
    // current badge = badge

You can clear the application's badge by passing null to setBadge(). Setting the badge will register the new value on the Sencha Web Application Manager server, which will proprogate to other devices that are owned by the user.
    .then(function() {
        // success
    }, function() {
        // failure

Local Notification

Notifications that are pushed from server can also be sent from your application.

var alert = {
    message: 'Hello!',
    icon: '',
    tags: ['local', 'sencha']
    .then(function() {
        // success
    }, function() {
        // failure

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