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
protected

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.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

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.

Sencha Fiddle 2.0

Guides
API
top

What's New

Fiddle 2 is a rewrite (both server and client) of Fiddle 1. We think it’s got a lot to offer over the first version. Here’s why:

Editor

Fiddle 1: The editor panel’s IDE used Code Mirror.

Fiddle 2: The editor uses Ace Editor including real-time jshint feedback in the left-hand gutter.

Code syntax highlighting options are expanded to include code types beyond JavaScript and CSS.

Linting prompts are displayed in the left-hand gutter next to the line numbers for JavaScript and CSS files when possible issues are detected.

Ctrl/Command-F in-file search is improved providing navigation between all search occurrences.

FILES / PACKAGES / DATA

The File System panel is available full-time by default. Though, the panel is collapsible for those looking to reclaim that real estate in the UI.

Fiddle 1: Ad hoc js and css resources could be added to the fiddle by adding them to the fiddle node in the File System panel.

Fiddle 2: In addition to js and css files you can now add HTML files.

Fiddle 1: Using Ext JS framework packages in your fiddle was challenging and often required that you were the one that built Fiddle itself to get the package loaded. ;)

Fiddle 2: Super easy access to framework packages They can now be added to a fiddle simply by checking a package shown in the File System panel.

Fiddle 1: Data files were static and could not respond to params sent to the "server" in a CRUD operation.

Fiddle 2: Data files now have a "Dynamic Data" checkbox that when checked allows you to inspect incoming params using javascript and deliver data dynamically.

Fiddle 1: Server side-type data assets were delivered to the fiddle via the Ext.ux.ajax.Simlet class. This meant that observing the data transactions for any CRUD operation were obscured as they were not observable through the network tab in the browser’s dev tools.

Fiddle 2: Data files are now delivered HTTP to your fiddle from the fiddle server. The data transaction’s upstream and downstream are observable in the browser’s dev tools as they would be in your own client-server environment. Additionally, the JS, CSS, and HTML files located in the File System panel are now also remote loaded.

Fiddle 1: There is no visual indicator to tell when a fiddle is "dirty" and should be saved before closing the fiddle.

Fiddle 2: All files / packages that have been added or modified will display with a yellow dot next to their names in the File System panel. The dot will be removed as additions and changes are saved.

New in Fiddle 2

Data templates may be used to mock up sample server responses within a user-defined template.

Support for loading plaintext and Ext Direct data assets is now supported in Fiddle 2.

Files from a saved fiddle may be used in other fiddles.

Saving and Forking

Fiddle 1: If you make changes to a fiddle and click the fork button the original fiddle will be saved and your changes will be lost.

Fiddle 2: Any changes you’ve made to the fiddle will be applied to the fork.

Fiddle 1: A fiddle could be opened in a new tab, but would need to be saved first. Then, running that fiddle view again with code changes meant saving your fiddle with additional changes and manually refreshing the preview tab.

Fiddle 2: Fiddles may be opened in a dedicated tab without first saving. Fiddle updates may then be viewed by clicking the Run button. The "Open in New Window" option in Fiddle 1 has been replaced by this interaction.

Fiddle 1: Fiddles could be given tags to improve their discover-ability in the search panel.

Fiddle 2: In addition to tags, fiddles can now be added to user-defined groups. Fiddle groups aims to improve organization of fiddles for quick retrieval outside of search.

New in Fiddle 2

Fiddle 2 has a user preferences panel allowing users to save preferences such as how and when a fiddle is run and whether to allow voice commands (saying "run code" will run the current fiddle provided the Editor is focused and the browser has been given microphone privileges).

In addition to being able to password protect a fiddle and opt out of having it show up in the search results you can also now lock a fiddle down. The locked fiddle may not be edited by other users and will prompt you as the originator to confirm an edit before saving changes is allowed.

Fiddle 2 enables users to create teams of Fiddle users with varying read/write permissions. Fiddles can then be added to those teams to manage public and private edit access.

Speed

A rewrite of the server-side logic using Node.js (Fiddle 1 used PHP), the remote file loading of files from the File System panel, and other server infrastructure updates have made Fiddle 2 faster than Fiddle 1. Search, saving, forking, and running fiddles should all process notably faster than before.

Rating System

A fiddle rating system is in place allowing saved fiddles to be rated up or down by unique users. The current rating and rating controls appear in the top toolbar next to the fiddle’s title.

Guides

Fiddle 1: Did not have a handy set of guides.

Fiddle 2: Has a handy set of guides.

Sencha Inspector

Sencha Inspector is great for inspecting an Ext JS application informing you of what components are created, what layout runs have occurred, etc. Sencha Inspector actually borrowed many of these functions from Fiddle 1 so in Fiddle 2 the duplicate functions were removed and was made very easy to connect to Sencha Inspector.

Sencha Fiddle 2.0

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation