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

Saving and Forking Fiddles

Fiddle 2 introduces a number of improvements and flexibilities when it comes to saving and sharing your work. Your code examples can be saved to the Fiddle server and then the link to your fiddle shared with coworkers or the community, but now with Fiddle 2 you have more control than ever over how each fiddle can be viewed, searched, and edited.

Forking

Saved fiddles can be forked creating a new fiddle ID. From there, all aspects of the fiddle may be changed including the title, description, code and folder structure, and save options. Forked fiddles will show you as the fiddle author. However, next to the fiddle title will be a fork icon that when clicked will open the parent fiddle.

If you open an existing fiddle and make changes prior to first forking the fiddle those changes will then be saved to your fork when you click the Fork button.

Save Options

Search Index

By default, when you save a fiddle it will be searchable in the search panel. To prevent a fiddle from showing up in the search results:

  1. Save your fiddle by clicking Save (or by using Cmd/Command-S with the editor focused)

  2. Click on the Admin button and choose "Permissions" from the context menu

  3. Uncheck "Search Indexable"

  4. Click Save

The fiddle along with its preferences will now be re-saved. The fiddle will no longer show up in the results in the Search panel.

Password Protected

Fiddles may be password protected to prevent unauthorized access. You can set a password for a fiddle using the steps above in the Search Index section of the guide. Just replace step 3 with:

  1. Enter the desired password in the "Password" field

Note: Password protected fiddles are not removed from the search results. The search results that are password protected will have a key icon to signify they are password protected. If you would like your fiddle to be excluded from search as well as password protected be sure to uncheck "Search Indexable".

Locked Fiddles

Fiddles are normally able to be opened, edited, and re-saved with new changes. However, there are times you don’t want a fiddle to be changed. By locking a fiddle you prevent it from being edited without first acknowledging a confirmation prompt. To lock a fiddle, follow the steps above in the Search Index section and replace step 3 with:

  1. Check "Lock"

Once locked, you will be shown a confirmation dialog asking if you want to save over your locked fiddle.

Teams

Fiddles may be assigned to one or more teams of users with each user having custom run / edit privileges. Creating teams and associating fiddles to a team offers granular control over select fiddles and who users may interact with them. As a user you may create teams of your own as well as be added to teams that other users create.

Viewing Existing Teams

The Teams panel may be viewed by:

  • Signing into fiddle

  • Click on your username

  • From the context menu choose "Teams"

The Teams panel displays any teams you’ve created or have been added to. The team panel displays:

  • Name - The name of the team

  • Creator - The username of the team creator

  • Public Read - "No" if the fiddles added to this team may be read by anyone outside of the team

  • Your Permission - Your permission level within the team (more on permission levels below)

  • [Edit Team] - A gear icon in the last column allowing you to edit the team parameters (if you are the creator or have a permission level of "Full Access")

  • [Leave Team] - An exit icon in the last column allowing you to leave a team you’ve been added to. You cannot leave a team you created.

You can search for existing teams by name using the search field at the top of the Teams panel.

Create a New Team

To create a new team, click on the "Create" button on the top-right of the Teams panel. Enter the desired team name and click “Ok”. The edit Team window for the new team will be shown. From here you can disable public read access to any fiddle added to the team by unchecking the “Allow Public Read” checkbox.

Renaming a Team

To rename a team open the Teams panel and click on the Edit Team (gear) icon next to the team you’d like to edit. In the edit Team window change the team name in the "Name" field and click the “Save” button.

User Management

Adding a New User

Click on the gear (edit team) icon next to the team you’re adding a new user to (the edit Team window will also be shown just after creating a new team). In the edit Team window click on the "Add User" button top-right. Enter the fiddle username of the user you want to add, choose a permission level for the user, and click “Choose User”.

User Permission Levels

Users may be assigned the following permission levels:

  • No Access

  • Read

  • Read + Write

  • Read + Write + Delete

  • Full Access

All permission levels apply to the fiddles associated to the team except for "Full Access". The “Full Access” level gives the user permission to read, write, and delete fiddles as well as add, modify, and remove users from the team.

Disabling Public Read Access

Un-checking the "Allow Public Read" checkbox is effectively the same as adding all users with the “No Access” permission. User must then be whitelisted by adding them to the team and giving them at least the Read access.

Removing Users

Team creators and users with "Full Access" permissions may add and remove users from a team. To remove a user open the Teams panel and click on the edit team (gear) icon. In the edit Team window click on the [X] next to the user you want to remove. Click on “Yes” in the Remove Item confirmation dialog.

Leaving a Team

You may opt to leave a team you’ve been added to by opening the Teams panel and clicking on the exit (Leave Team) icon. Next, click "Yes" on the Leave Team confirmation dialog.

Adding a Fiddle to a Team

To add a saved fiddle to one or more teams:

  1. Click on the "Admin" button and then select “Teams” from the context menu.

  2. Click the "Add to Team" button in the top-right.

  3. Select the target team from the "Team" combo field in the Find Team window (typing in the field will filter the teams list)

  4. Click "Choose Team"

The team or teams your fiddle belongs to will display in the Fiddle Teams window.

Removing a Fiddle from a Team

  1. Open the fiddle whose teams you want to manage

  2. Click on the "Admin" button in the left toolbar and choose “Teams”

  3. In the Fiddle Static Groups window click on the "X" next to the team you want to remove the fiddle from

  4. Click "Yes" in the Remove From Team confirmation prompt

Groups

Fiddles may be added to one or more user-defined groups. Groups are "albums" of fiddles that provide additional user-defined organization for your fiddles (for permissions management see Teams). In addition to user-defined groups there are default Dynamic groups that automatically curate the fiddles included in the group based on select, pre-defined search criteria

Viewing Existing Groups

The Groups panel may be viewed by:

  • Signing into fiddle

  • Click on your username

  • From the context menu choose "Groups"

The Groups panel displays any teams you’ve created or have been added to. The Group panel displays:

  • Name - The name of the group

  • Creator - The username of the group creator

  • Public - "No" if the group should not be visible to other users

  • [Show Fiddles] - An expand icon in the last column that shows the fiddles in the group

  • [Edit Group] - A gear icon in the last column that opens the edit Group window

  • [Delete Group] - An X icon in the last column that deletes a group

You can filter the groups using the "search…" field above the groups grid. The search is performed on the group name.

Create a New Group

To create a new group, click on the "Create" button on the top-right of the Groups panel. Enter the desired group name and click “Ok”.

Renaming a Group

To rename a group open the Groups panel and click on the Edit Group (gear) icon next to the group you’d like to edit. In the edit Group window change the group name in the "Name" field and click the “Save” button.

Deleting a Group

To delete a group open the Groups panel and click on the Delete Group (X) icon next to the group you’d like to delete. Click "Yes" in the Delete Group confirmation dialog.

Adding a Fiddle to a Group

To add a saved fiddle to one or more groups:

  1. Click on the "Admin" button and then select “Groups” from the context menu.

  2. Click the "Add to Group" button in the top-right.

  3. Select the target group from the "Group" combo field in the Find Group window (typing in the field will filter the groups list)

  4. Click "Choose Group"

The group or groups your fiddle belongs to will display in the Fiddle Static Groups window.

Removing a Fiddle from a Group

  1. Open the fiddle whose groups you want to manage

  2. Click on the "Admin" button in the left toolbar and choose “Groups”

  3. In the Fiddle Static Groups window click on the "X" next to the group you want to remove the fiddle from

  4. Click "Yes" in the Remove From Group confirmation prompt

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