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, 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.

Rapid Ext JS 1.1.0


top

How to open a Sencha Architect based applications

  • If you already have a Sencha Architect application, you can export it in Rapid Ext JS, which will migrate it to an ext-gen application.

    Open Existing Project

  • Select the Sencha Architect Application folder and click Import Button.

    Select Folder

  • It will start migrating Sencha Architect to ExtGen Application.

    Select Folder

  • Once the Application is generated, open any view file extending with *.js

Please note that Rapid Ext JS follows Sencha migration process - Migrate Existing Ext JS + Sencha Cmd applications to Open Tooling and npm Packages. Hence, it is recommended that developers manually verify that the project has migrated.

FAQ

What should I do if my Sencha Architect project contains ext.tree.grid and I encounter an error after migrating to ExtGen using Rapid?

  • If your Sencha Architect project includes Ext.tree.Grid, migrating it to ExtGen using Rapid may result in an error.

To resolve this issue:

Manually add the Ext.tree.Grid package to the requires configuration before starting the migration process. During the migration, ExtGen will automatically install the package as part of the process. By ensuring the package is included in the requires list beforehand, you can avoid any compatibility errors during the migration.

Declare the Package in app.json

  • Migrating Applications with Custom Themes

If your Sencha Architect application uses a custom theme, you may encounter errors during migration. Follow the steps below to resolve this issue:

Steps to Include Custom Theme After Migration

  1. Manually Include the Custom Theme

    • After completing the migration process, navigate to your application's root folder.
  2. Update app.json

    • Open the app.json file located in the application's root directory.
    • Locate the "theme" configuration block.
    • Update the name property with your custom theme name.

    Example:

    "theme": {
        "name": "my-custom-theme"
    }
    
  3. Rebuild the Application

    • Execute the Run Build from action commands to regenerate the application with the applied custom theme.

By following these steps, the custom theme will be correctly integrated into your application after migration, preventing compatibility errors.

Resolving Package Errors When Migrating a Sencha Architect Application

If you encounter errors related to packages while migrating a Sencha Architect application, follow these steps to resolve them:

Steps to Fix Package Issues

  1. Open app.json

    • Locate the app.json file in your migrated Rapid Ext JS application's root directory.
  2. Check the requires Section

    • Look for the "requires" array inside app.json.
    • Ensure all listed packages are valid and correctly spelled.

    Example: ```json "requires": [

    "font-awesome",
    "charts",
    "my-custom-package"
    

    ]

  3. Update package.json Dependencies

    • Open the package.json file and navigate to the dependencies section.
    • Review and correct the package paths.

      Example: Change

      "@sencha/ext-sencha-charts""@sencha/ext-charts"

      Refer to the Ext JS NPM Package names here.

    • After making the updates, run the following in the terminal:

      npm install from root of the project.

    • Once installation completes, go to Action Commands and click Restart Watch.
  4. Rebuild the Application

    Execute the Run Build from action commands to regenerate the application with the applied custom theme.

By following these steps, you should be able to resolve package-related errors and successfully migrate your Sencha Architect application.

Rapid Ext JS 1.1.0