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.

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.

Themer 1.1.0


Connecting Themer to Your Application

As of Themer 1.1.0 you can connect Themer with an existing application and view changes made to a custom theme in your app real-time. You won’t need to change how you create your application or custom theme in order to take advantage of this feature.

Supported Browsers

Inspecting an App with Themer is currently supported in the following browsers:

  • Google Chrome
  • Mozilla Firefox
  • Microsoft Edge*
  • Safari*

* Enabling/disabling Inspect from the browser window (Cmd/Ctrl + I) is not supported in these browsers.

Getting Connected

Once you’ve created an app and custom theme within Themer follow these steps to connect your app to Themer:

  1. Copy the config object below and add it to the "js" block in your application’s app.json file:

         "path": "http://localhost:8900/resources/themer/js/themerInspect.js",
         "remote": true,
         "bootstrap": true
  2. From your terminal / command line CD into your app directory and run:

     "sencha app watch -fashion"

    Note: Be sure you’re running Cmd 6.2.0 or higher

  3. When running "sencha app watch -fashion" you’ll see a line like:

     [INF] Application available at [http://localhost:1841](http://localhost:1841)

    In your browser visit http://localhost:1841 (using the app location indicated by the app watch process since the port may be different - for ease we’ll continue to reference port 1841 in this guide).

  4. Your app and Themer should now be connected. You can confirm the connection to the application within Themer. In Themer click on "View > Connected App(s)". The Connected App(s) dialog should now show something like:

    Sencha Application: http://localhost:1841

Your application is now synced, in-browser, to Themer. You may connect additional browsers on the same network to see changes occur on multiple browsers / platforms at the same time. As you connect additional browsers, the connections will update and reflect in the Connected App(s) window.

Live Updates

With your application now connected to Themer, changes you make to your custom theme within Themer will be reflected real-time in your browser window (or as many browsers as you have pointed to http://localhost:1841). Try making changes to the Base Color in Themer’s "Theme Defaults" view.

As the color is changed the application in the connected browser will update along with the component views within themer. Aspects of any component supported in Themer may be updated with changes reflecting real-time in your connected app.

Easy App Inspection

In addition to making changes to any available component in Themer you can also inspect components directly within your own application.

To inspect components in your application first click on the "Inspect" button in Themer (alternatively you can use the hot-key Ctrl-i / Command-i with either Themer or your application window focused). Themer will now show “Inspecting App in Browser”.With the Inspect option active, hover your cursor over the components in your application. Components eligible for theming will be framed with a red dashed outline.

Clicking on an eligible component will outline the component in red and reveal its theming options in Themer. Changes made to the theme this way will apply to the theme itself and live update within your app just as you’d expect had you made the changes in Themer alone.

To turn off the Inspect option you can click on the Inspect button in Themer or press Ctrl-i / Command-i. When hovering components in your application you’ll no longer see components outlined in red.

Disconnecting / Reconnecting Your App

You can close any connected application window / tab to disconnect it from Themer.

Re-entering http://localhost:1841 will reconnect the application to Themer at any time. You can verify the connection in Themer by choosing View > Connected App(s). To disconnect Themer from any and all open application windows you can stop the "sencha app watch -fashion" process by pressing Ctrl-c / Command-c in your command line.

Themer 1.1.0

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

Sencha Test

2.0.1 2.0.0 1.0.3



Sencha Themer

1.1.0 1.0.2


4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation