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, inheritance, and read only. 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.

Architect 3


App Template File Structure

For instructions on creating a custom app template, see Creating app templates.

The files and directories for an installed custom app template are:

template.json                # Template metadata such as title, category and description 
template.xda                # Project archive containing the template code
preview.png                    # (Optional) Preview PNG image. 
preview/                    # (Optional) Provides a live preview of template within architect        
    app/                    # Any architect app with index.html can be used for preview

By default, the files for a custom app template are located under Documents/Architect/Templates. Templates are dynamically read from the folder, which means you can easily share sets of templates via source control, or by copy/paste.

This location can be changed in settings by going to

Edit Menu > Preferences > File > Templates.

Any existing templates will automatically be migrated if this location is changed.

It is important to try and keep templates as lean as possible. When templates are created from current projects or project archives .xda files, any unneeded items such as build files, user settings, or SDK files are automatically removed.

Template Preview Images

You may include a preview.png file with a template to provide users with a visual preview in Architects template browser. The recommended sizes for preview images are:

  • For desktop or tablet targeted templates: 800x600
  • For phone targeted templates: 325x525

Template Previews

You may also include a live preview along with a template. When you create a template from the current project or from a project archive .xda file, a preview folder is created automatically for you, however you may edit the preview files at any time.

Note: The preview folder must contain an index.html file to work properly.

Template Metadata

The template metadata is stored in template.json like so:

    "title": "Button Template",
    "name": "ButtonProject",
    "description": "A template with a big button.",
    "category": "My Templates",
    "framework": "ext42"

The following template values are stored there.

Property Type Required Default Description
name string true -- The project name of the template. (Should not be edited)
framework string true -- The template framework. Example "ext42". (Should not be edited)
title string true -- Display title to use in the template browser.
category string true -- Category to display the template within the template browser.
description string false -- A detailed description for the template.
usePreviewImage boolean false false Force the template to use a preview image rather than a live template.
profile string false -- Determines how a template is displayed and previewed in the template browser.

Advanced Template Editing

To edit templates after they have been created or imported, edit them directly in your local templates folder. You may edit the template.json metadata file, preview image, and live preview files directly. However, since the actual template code is stored internally as a project archive template.xda, you must edit it in Architect using the following method.

  • Locate the template.xda file in the template folder.
  • Select "File" > "Import Archive"
  • Edit the project as needed, then save to a temporary location.
  • Select "File" > "Archive Project".
  • Save the new project archive as template.xda in the template folder, overwriting the original archive file.
  • Ensure that the framework and category values in the template metadata match that of the archived project.

Template Versioning and Upgrades

Templates are specific to a version of ExtJS. The framework value in template.json should not be changed unless the template.xda is also upgraded. If you are upgrading a template, it is probably best create a new project from the template, upgrade the project to the desired framework, then create a new template from the open project. For more details on upgrading a projects library version, see Using Resources > Upgrading the Library

Architect 3