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


Release Notes for Themer 1.1.0 GA

March 14, 2017

What's New

Improve UIs in Themer

  • UIs now appear as 'components' instead of individual UIs in the framework.

  • Expanded support for UIs to include more components like grid, tab panel, etc.

  • Example configuration for applying a UI to a component in code are provided in Themer.

Inspect App in Browser

A running app can be connected to Themer and inspected directly in the browser. Two methods for connecting an app:

  • app.json configuration change

  • bookmarklet

Inspect Component Tree

During inspect, a tree of components is displayed in Themer, facilitating selection of specific components.

Import Colors

CSS or other plain text files can now be imported. Color values within the file can then be added to the palette in Themer.

Bug Fixes/Improvements

  • [CAT-25] - Transparent color in the colorpicker field's trigger

  • [CAT-141] - Getting "appInfoObj.sass.var.filter is not a function" when opening custom theme

  • [CAT-154] - Exported SCSS package content does not follow best practices

  • [CAT-163] - Grid Paging toolbar is missing

  • [CAT-190] - Missing display example for disabled button

  • [CAT-293] - Modern Datepicker's dark overlay stays after switching widget

  • [CAT-332] - Modern. Border color in Form doesn't work.

  • [CAT-341] - Modern. Panel Border section doesn't work

  • [CAT-344] - Modern. Section Tab Badge in Tab Panel doesn't work

  • [CAT-366] - Modern. Spinner Is missing Disabled example.

  • [CAT-370] - Modern. Inspecting Grid cells returns nothing.

  • [CAT-411] - Font Variables not grouped on modern button UI

  • [CAT-416] - UIs Classic. Extjs Button Toolbar Large/Medium/Small does nothing.

  • [CAT-430] - Custom UI. The configs and sections are scrambled in custom UIs

  • [CAT-433] - Changing transparency in color palette messes up the color

  • [CAT-447] - Modern Custom UI. WebFont dissapears from the dropbox

  • [CAT-448] - Custom UI. Tabbar shows the Theme Default

  • [CAT-449] - Custom UI. Toolbar Font and Border doesn't work

  • [CAT-456] - Rename UI

  • [CAT-458] - Enable Inspect in UIs

  • [CAT-472] - Editing Google Fonts url on Mac results in error

  • [CAT-488] - Inspect App doesn't work with Edge

  • [CAT-489] - Modern. Tooltip keeps on top of the other widgets

  • [CAT-490] - Buttons for Modern/Classic part of the Theme don't hide in non-universal Themes

  • [CAT-492] - Custom UI. Too many changes to UI can cause crash of UI

  • [CAT-493] - Custom UIs doesn't work on Linux

  • [CAT-499] - The updater is not checking if the user has higher version

  • [CAT-504] - Themer deletes .sencha folder on error when opening existing theme

  • [CAT-506] - Classic side of Themer doesn't work

  • [CAT-511] - Custom UI. Form has non-working configs.

  • [CAT-513] - Custom UI. Select has non-working configs.

  • [CAT-514] - Custom UI. Slider has non-working configs.

  • [CAT-517] - Custom UI. Tree has non-working configs.

  • [CAT-520] - Themer says "no settings exist for the selected component"

  • [CAT-530] - SDK selection should be hidden when adding creating a new theme in an app

  • [CAT-531] - View... Connected Apps is hard to read

  • [CAT-533] - Component Tree is empty when first opened

  • [CAT-534] - UI issues with Component tree

  • [CAT-535] - Component tree stays on preview when inspecting an app

  • [CAT-539] - Can't set background color of button ui

  • [CAT-540] - Toolbar button component styles and UI are missing

  • [CAT-541] - Component Tree: Leaf nodes shouldn't have expanders

  • [CAT-542] - UIs aren't shown when inspecting classic buttons

  • [CAT-544] - Component Tree does not refresh when components are added or removed

  • [CAT-545] - Opening/closing sections in the left pane causes Ext JS to freeze

  • [CAT-547] - Toggled Inspect off, still see "Inspecting App in Browser" (modern)

  • [CAT-549] - Classic CustomUI. Tooltip UI configs are maxing out CPU.

  • [CAT-553] - Breadcrumbs preview does not load

  • [CAT-555] - Component Tree won't select inside of a buttongroup

  • [CAT-556] - Component Tree not hidden when Inspect is toggled off

  • [CAT-558] - Color Import. Same color can be imported more then once

  • [CAT-559] - Dashes in UI variables

  • [CAT-561] - EA timebomb update

  • [CAT-565] - Once a node is selected in the component tree it cannot be collapsed

  • [CAT-566] - Triggering Inspect from Connected App is broken

  • [CAT-569] - Inspect should be toggled off when the user selects a different item in the nav tree

  • [CAT-570] - No settings displayed when inspecting a tree or grid

  • [CAT-572] - UI name uniqueness not enforced

  • [CAT-573] - Classic Tooltip example should be centered

  • [CAT-574] - Modern side of Themer doesnt work with Ext 6.0

  • [CAT-577] - UIs Migration causes Viewer to flicker

  • [CAT-579] - TreeList Modern UI isn't applied correctly

  • [CAT-580] - Pop-up Errors/Warnings when inspecting app

  • [CAT-582] - Improve responsiveness when adding and removing UIs

  • [CAT-584] - No way to set border radius for Panels in modern

  • [CAT-585] - Intermittent Error when creating UI

  • [CAT-587] - No example for classic fieldset ui

  • [CAT-588] - Double click on the Custom UI's expander crashes the left menu

  • [CAT-589] - Classic CustomUI cannot be created. Sometimes.

  • [CAT-590] - Show all UI parameters when inspected component has no parameters

  • [CAT-592] - Filter Nav when Inspecting Viewer

  • [CAT-594] - Inspecting some element changes left menu

  • [CAT-596] - Timebomb version of Themer has incorrect version number

  • [CAT-597] - Inspect is showing configs for widget that was previously inspected

  • [CAT-603] - Theme Settings and SASS variables text gets cut off

  • [CAT-604] - Grey icons in tooltip need to be removed

  • [CAT-606] - Breadcrumb Example Blank

  • [CAT-608] - Undo/Redo not working

  • [CAT-613] - Inspecting an element in an app should prevent click on underlying element

  • [CAT-616] - Classic Button. Pressed border doesn't work.

  • [CAT-617] - Update Timebomb for EA

  • [CAT-619] - Classic FieldSet has non-working Checkbox Margin

  • [CAT-621] - Classic Slider has redundant border config

  • [CAT-636] - Classic Tree Micro. Indicator is missing in Tree List items

  • [CAT-637] - Workaround Windows UI Creation Bug

  • [CAT-641] - Classic Custom UI Toolbar creates Button and Toolbar

  • [CAT-644] - Classic Custom UI Button. Renaming the Button causes a render glitch.

  • [CAT-654] - Classic: Empty text color of Textfield custom UI doesn't affects preview

  • [CAT-660] - Apply Theme no longer detects the App/Workspace

  • [CAT-668] - Modern List. Empty Text Padding doesn't work

  • [CAT-669] - Modern Tooltip. Size doesn't work.

  • [CAT-681] - Fix SassMixinsBuilder for Classic Toolbar Buttons

  • [CAT-682] - Themer stucks on Migrating Uis after creating/loading theme

  • [CAT-685] - Theme won't open

  • [CAT-687] - Delete UI not working in classic

  • [CAT-689] - Can't change colors on Linux 64 bit when workspace created by Themer itself

  • [CAT-691] - Classic Custom UI Button cannot be created in Classic themes

  • [CAT-692] - After deleting Custom UI the Theme is stuck in Updating UIs

  • [CAT-697] - Mixins created with same name will collapse into one mixin after saving

  • [CAT-700] - Blank space - import colors window

  • [CAT-702] - URL to Documentation in Themer is wrong

  • [CAT-703] - Renaming Custom UIs causes the Css to stop working

  • [CAT-705] - Offline license activation is missing email

  • [CAT-706] - Modern - Few configs do not work in Neptune theme

  • [CAT-719] - Inspecting in Classic doesn't work

  • [CAT-720] - Inspect in Modern

Known Issues

UIs are not supported in Modern 6.0. All other toolkit/framework version combinations allow UIs to be created and managed in Themer.

Themer 1.1.0 EA

January 25, 2017

EA Released

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