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 7.8.0 - Modern Toolkit


top
Guide applies to: modern

Troubleshooting npm

Here are some tips and tricks for trouble shooting the node package manager.

If you are a TRIAL customer

The Ext JS 30-day trial packages are available to install from public npm. Install the latest Ext JS version using the following command and skip to Step 2.

$ npm install -g @sencha/ext-gen

If you are an ACTIVE customer

Ext JS and all related commercial packages are hosted on Sencha's private npm registry. Login to the registry using the following command which configures npm to download packages in the @sencha scope from Sencha's registry.

Username Note:

The email and password used during support portal activation (after license purchase) will be used to login to Sencha’s NPM repo. The username is the same as the email used, however, the @ character is replaced with '..' two periods. For example [email protected] converts to username: name..gmail.com

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

$ npm install -g @sencha/ext-gen

Community Edition

https://docs.sencha.com/extjs/7.0.0-CE/index.html

npm Reset

These steps could be used to reset the npm system, should you encounter auth issues (403's) or checksum errors.

Linux / macOS

  1. Run rm ~/.npmrc - removes the stored npm repository credentials. This location may be different on your system.
  2. Run npm cache clean --force or rm -rf ~/.npm - clean the npm packages cache by removing it.
  3. Run npm login --registry=https://npm.sencha.com --scope=@sencha - log back into the repository.
  4. Run npm install -g @sencha/ext-gen or npm install -g @sencha/ext-react-gen

Windows (Command Prompt)

  1. Run del %HOMEPATH%\.npmrc - removes the stored npm repository credentials. This location may be different on your system.
  2. Run npm cache clean --force or rmdir /s /q %HOMEPATH%\AppData\Roaming\npm - clean the npm packages.
  3. Run rmdir /s /q %HOMEPATH%\AppData\Roaming\npm-cache - clean the npm cache by removing it.
  4. Run npm login --registry=https://npm.sencha.com --scope=@sencha - log back into the repository.
  5. Run npm install -g @sencha/ext-gen or npm install -g @sencha/ext-react-gen

403 Errors

When authorization errors show up on npm.sencha.com.

The first to do is verify that you are properly authenticated with our repository by verifying you have been given an access token in your .npmrc file.

Windows: Verify Authorization Token, View the Contents of .npmrc

  1. Run type .npmrc from the home directory (%HOMEPATH% or wherever your installation put this file).

Linux / macOS: Verify Authorization Token, View the Contents of .npmrc

  1. Run cat .npmrc from the home directory (~/ or wherever your installation put this file).

Attempt to Re-Authenticate

  1. Run npm login --registry=https://npm.sencha.com --scope=@sencha and login to the npm repo again.
  2. Run npm --registry https://npm.sencha.com whoami testing your athorization.
  3. Run npm install -g @sencha/ext-gen or npm install -g @sencha/ext-react-gen to verify that your logged in.

403 Errors for Premium Components

Premium components require you have purchased the premium component in the product matrix in the store. If you haven't purchased the products premium component it will throw a 403 exception when you try run npm install for the products premium component.

  • Check the store to compare the product packages matrix. Check the support portal subscription information, product code, and that can be used to tell you which product package edition you have in the matrix in the store.

Project Reset

There may be times where a reset of the node packages / dependencies within a project is necessary.

Windows (Command Prompt)

  1. Run rmdir /s /q node_modules removing the node_modules directory in your project.
  2. Run npm install downloading the dependencies again.

Linux / macOS

  1. Run rm -rf node_modules removing the node_modules directory in your project.
  2. Run npm install downloading the dependencies again.

npm Run Scripts

Using Build Profiles in npm Scripts

When you generate your application with ExtGen, two npm build scripts are provided to get you started. The first script is dev. The dev script will build the development version of your application and launch it in a browser. The second script is the build script. This script is designed to created a production-ready version of your application.

As with Sencha Cmd, your app.json will contain build profiles in the builds object. By default, the desktop build profile is specified as the build profile you want used in the build script for building your production application. You can specify which build profile you want used in an npm script by setting a script argument for --env.profile like this:

"dev": "webpack-dev-server --env.profile=phone --env.browser=yes --env.verbose=no",
"build": "npm run clean && cross-env webpack --env.profile=desktop --env.environment=production --env.treeshake=yes"

I have added a build profile and now I can't build

When adding a build profile in the app.json you have to review it and verify that all the paths exists. For example, if you generated your application with ext-gen, make sure the {build.id}/some/path exists in your project. Ensure that you go through the entire app.json and verify all the paths exist in your code.

This is an error that shows up when an app.json property path does not exist.

% sencha app build
Sencha Cmd v7.X.X.X
[INF] Processing Build Descriptor : desktop (production environment)
[INF] Loading compiler context
[INF] Loading app json manifest...
[ERR] Failed to resolve dependency MyExtGenApp.Application for file MyExtGenApp.app.$Application
[ERR] 
[ERR] BUILD FAILED
[ERR] com.sencha.exceptions.ExNotFound: Unknown definition for dependency : MyExtGenApp.Application
[ERR] 
[ERR] Total time: 3 seconds
...

Once you add the missing paths from the app.json in your project it will build.

  • You can create any number of scripts to suit your needs, we simply provide an example of a development build and a production build for your convenience.

Ext JS 7.8.0 - Modern Toolkit