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.

Ext JS 6.7.0


top

Getting Started with Ext JS Using Open Tooling

This guide will show you how to install and configure Ext JS framework using open tooling in your development environment.

Requirements

The Ext JS tooling requires NodeJS and Java.

Creating Your First Ext JS Application

Step 1: Sign Up

To gain access to the Sencha NPM repository.

  1. Start a free trial of Ext JS.
  2. Purchase Ext JS.

Step 2: Login to the NPM repository

Once you've signed up or purchased the product, start by logging into the repository with the @sencha scope.

  • npm login --registry=https://npm.sencha.com --scope=@sencha

Note: Existing customers use your support portal credentials. But switch the username, @ character with '..' two periods, so the username would look something like this after it's converted: name..gmail.com.

Step 3: Install the App Generator CLI

Then install the Ext JS app generator CLI command ext-gen. This will allow you to quickly create an Ext JS application.

  • npm install -g @sencha/ext-gen

Step 4: Create an Application

Then quickly create a barebones application with ext-gen.

  • ext-gen app -a - This generates an application called MyApp.

App Generator Interactive Walkthrough

Turn on the interactive options and this will ask you how to build your application.

  • ext-gen app -i

    Would you like to see the defaults for package.json? (y/N)

    If you select `yes`, ext-gen will show all defaults for package.json
    

    Would you like to create a package.json file with defaults? (Y/n)

    This will create a package.json with the defaults
    

    What would you like to name your Ext JS app? (MyApp)

    Type name of your app
    

    What type of Ext JS template do you want? (Use arrow keys)

    ❯ make a selection from a list
    type a folder name
    

    What Ext JS template would you like to use?

    ❯ moderndesktop
    universalmodern
    moderndesktopminimal
    

    Would you like to generate the Ext JS npm project with above config now? (Y/n)

    Last question, output the results. 
    

App Generator CLI Reference

ext-gen app (-h) (-d) (-i) (-t 'template') (-m 'moderntheme') (-c 'classictheme') (-n 'name') (-f 'folder')

CLI Options Alias Description
-h --help show help (no parameters also shows help)
-d --defaults show defaults for package.json
-i --interactive run in interactive mode (question prompts will display)
-t --template name for Ext JS template used for generate
-c --classictheme theme name for Ext JS classic toolkit (not in Community Edition)
-m --moderntheme theme name for Ext JS modern toolkit
-n --name name for Ext JS generated app
-f --folder folder name for Ext JS application (not implemented yet)
-v --verbose verbose npm messages (for problems only)
Templates Description
moderndesktop This is a modern Ext JS template only.
universalmodern This is a modern and universal template.
moderndesktopminimal This is a modern desktop miniumal template.

Step 5: Run the New Application

Start up the newly created application in the default browser with these commands.

  • cd ./<your-app-name>
  • npm start

Step 6: Modify the Application

The resulting app uses the webpack-dev-server. So any changes you make will be immediately reflected in the browser.

  • Modify your source code.
  • Then check the browser, it will auto reload and update with the new changes.

Premium Packages - Add App Functionality Quickly

You can add Ext JS premium npm packages to add more functionality quickly. Follow the two steps required to add the premium packages.

Premium Packages Description
Calender Event management
Exporter Data export tool.
D3 Data visualization.
Pivot Grid Data analytics
 
More packages Other package options

Step 1: Requires

Add the name of the package in the requires section in the app.json file.

  • Example
"requires": [
    "calendar",
    //...
],

Step 2: NPM Package

Add the premium NPM package.

  • Implementation

    npm i --save @sencha/ext-<premium-package>
    
  • Example

    npm i --save @sencha/ext-calendar
    

Step 3: Workspace

In workspace.json append the dir variable under packages with new premium package location. ${framework.dir}/../ext-<premium-package>

  • Example before
"packages": {
"dir": "${workspace.dir}/packages”,
  • Example after
"packages": {
"dir": "${workspace.dir}/packages,${framework.dir}/../ext-calendar",

Ext JS 6.7.0