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

Working with Files

The way fiddles and the backing Ext JS framework are processed for each fiddle has been overhauled between the first iteration of Fiddle and the second. The rewriting of Fiddle’s file management serves to improve your ability to debug a running fiddle and results in a more flexible and naturalistic way of interacting with files.

Note: This guide focuses on the architectural changes in the file system at large. For specifics on working with remote data assets specifically see the Making Data Requests guide.

In Fiddle 1 your fiddle code was concatenated with the dev build of the selected Ext JS framework when running a fiddle. If you ran a fiddle in Fiddle 1 and viewed the element tab you’d see the code from any of your files from the Fiddle File System view concatenated into a script tag on the HTML page. In Fiddle 2, each file owned by the fiddle, including the default app.js file, will be delivered down to the browser as unique file requests.

The benefit of having each file delivered individually is that your code is easier to debug in the browser’s dev tools. Fiddle 2’s file delivery matches what you’d see when developing locally with unique files.

The caveat would be that with Fiddle 1 you did not have to explicitly include classes in separate files using a requires config or Ext.require(); all of your files were automatically concatenated for you. In Fiddle 2, user-added files will need to be required in order for each file / class to be loaded via the Ext JS loader just as you would in a local environment.

If you load a saved fiddle that was created with Fiddle 1, Fiddle 2 will still run the code in the concatenated means like Fiddle 1 would. When you save that fiddle, Fiddle 2 will ask if you want to upgrade it to version 2. This means it will be run in the new format where each file is expected to be required in order to load. There is also a menu item under the ‘Admin’ menu in the left toolbar to upgrade it (upgrading a fiddle to the Fiddle 2 load format is permanent).

Adding Folders and JS Files

Fiddle treats files and folders the same as if you had created files and folders for an application on your own local drive. By default, Fiddle creates an Ext application whose appFolder config is set to ‘app’. This means that any user-defined class added using the application’s namespace (the name config on the Ext application - defaults to "Fiddle") will be fetched from an ‘app’ folder.

Example

Let’s say you want to add a user-defined class called "Fiddle.main.Main" to your fiddle that will be used as the Ext application’s main view. To do so, you’d take the following steps:

  1. Right-click on the Assets folder in the File System panel and click "Create Folder"

  2. A new tree node will be added under the Assets folder with an editor control focused. Enter the name of "app" and press Enter (or blur the field)

  3. Right-click on the newly created "app" folder and click “Create Folder” and give the new sub-folder a name of “view”

  4. Right-click on the newly created "view" folder and click “Create Folder” and give the new sub-folder a name of “main”

  5. Right-click on the "main" folder and click “Create JS File”. Name the new file node “Main.js”

  6. Include the following starting code:

     Ext.define(’Fiddle.view.main.Main’, {
         extend: ’Ext.panel.Panel’
     });
    

If you now add a mainView config to your Ext application of "Fiddle.view.main.Main" the Main.js file will be fetched from the Fiddle server at “app/view/main/Main.js” when the fiddle is run.

Note: An Ext application is created by default which sets the app folder path for classes using the app name.
But, you can define alternative class name-spaced files and manage how they’re loaded using the Ext.Loader class.

CSS Files

CSS files may be added anywhere in the File System tree by right-clicking on a folder node and choosing the "Create CSS File" menu option. Any CSS files added will be linked to the running fiddle automatically. They will be linked after the framework CSS allowing you to author custom rules as well as override framework rules.

Note: Multiple CSS files may be added, though the order they are loaded is not user-definable. Duplicate CSS rules may result in unintended collisions.

HTML Files

By default each new fiddle has an "index.html" file in the Assets folder. Any content added to the “index.html” file will be placed in the running fiddle’s body tag. The “index.html” file is a way to add custom markup to the page to be used by your Ext fiddle.

Additionally, you can add your own HTML files by right-clicking on a folder node and choosing the "Create HTML File" option. In these files you can author any HTML page content you’d like.

Remote Files

Non-Fiddle Files

Remote JS and CSS resources may be added to a fiddle. Simply right-click on a File System tree node and click "Add Remote JS File" or “Add Remote JS File” and add the URL of the remote file. The remote resources are added to the running fiddle after the framework JS and CSS resources.

For example, you can add the following two remote files to a fiddle to access the OpenLayers mapping API:

JS: https://openlayers.org/en/v3.18.2/build/ol.js

CSS: https://openlayers.org/en/v3.18.2/css/ol.css

Note: Since Sencha Fiddle is loaded using the https protocol, remote files need to be loaded via the same protocol or else the browser will deny the request. Fiddle 2 attempts to detect if a file is using the http protocol and proxies the request so the browser can load against https but the end request goes to the http protocol.

Remote Fiddle Files

Files added to one fiddle may also be resourced by another fiddle. Once a fiddle is saved you’ll be able to access any files on that fiddle using the fiddle URL / fiddle ID / file path. For example, if we were wanting to load the "app.css" file from the fiddle with ID “abcd” (a CSS file added to the Assets folder in the “abcd” fiddle’s File System panel) we’d use the following URL when adding the remote CSS file to our current fiddle:

https://fiddle.sencha.com/fiddle/abcd/app.css

To add "abcd" fiddle’s “app/view/main/Main.js” file we would add:

https://fiddle.sencha.com/fiddle/abcd/app/view/main/Main.js

Additionally, you can use the Ext.Loader class to point a fiddle for any classes you would like the loader to fetch ad hoc as if they were on your own file system. To see how this might work let’s take a look at the following example fiddle code:

Ext.Loader.setPath('MyLib', '/fiddle/abcd/mylib');

Ext.application({
    name : 'Fiddle',

    requires : [
        'MyLib.plugin.TextSelector',
        'MyLib.util.WagesMath'
    ],

    launch : function() {
        // … your application code for your fiddle
    }
});

In this example, we’re wanting to require one or more classes using the MyLib namespace from the "abcd" fiddle. The setPath statement points all MyLib requirements to /fiddle/abcd/myLib. So, what we’d expect in this situation is that in the “abcd” fiddle there is a {FileSystem}/Assets/mylib/plugin/TextSelector.js file and a {FileSystem}/Assets/mylib/util/WagesMath.js file that define MyLib.plugin.TextSelector and MyLib.util.WagesMath classes respectively.

Lastly, you can fetch remote data assets by including the data file’s url in your application code wherever a remote URL is required. For example, you could set up a .json data file on the "abcd" fiddle called “Employee.json”. Then in a component’s store config you could do something like:

store: {
    proxy: {
        type: 'ajax',
        url: '/fiddle/1isc/Employee.json'
    }
}

For more information on how to use data files in Fiddle see the Making Data Requests guide.

Renaming Files

Files added to a fiddle can subsequently be renamed by right-clicking on them and choosing "Rename" from the context menu. Enter the new name and press Enter.

Note: Renaming a remote file changes the URL of that remote file.

Deleting Files

To remove a file right-click on it and choose "Delete" from the context menu. You will be prompted to confirm the deletion.

Note: Renaming and removing files that are required / linked in from other fiddles will break the linking as the files are loaded live as needed by the dependent fiddle.

Framework Packages

Framework packages are code packages available from Sencha in addition to the core framework classes / theme. Framework packages may be resourced by a fiddle by placing a checkbox next to the required package name under the "Packages" folder in the File System panel. For example, if your fiddle requires the Ext.google.ux.Client class you will need to place a check next to the “google” package. Removing a package from a fiddle is as as easy as un-checking the package name.

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.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation