npm Repository Access
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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
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
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
Use this step when you need to login in server enviroment.
~/.npmrc file. Using npm commands. Replace the $SENCHA_NPM_TOKEN_VERDACCIO with the token from your ~/.npmrc file.
npm config set @sencha:registry https://npm.sencha.com/
npm config set //npm.sencha.com/:_authToken=$SENCHA_NPM_TOKEN_VERDACCIO
Create and write a ~/.npmrc file. Replace the %npm.sencha.com-authtoken% with the token from your ~/.npmrc file.
# Remove previous file
rm -f ~/.npmrc
# Write new ~/.npmrc
echo "Writing auth tokens to ~/.npmrc"
echo "@sencha:registry=http://npm.sencha.com" >> ~/.npmrc
echo "//npm.sencha.com/:_authToken=%npm.sencha.com-authtoken%" >> ~/.npmrc
# Debug
echo "Debug contents of ~/.npmrc:"
echo "~~~~~~~~~~~~~~~~~~~~~~"
cat ~/.npmrc
echo "~~~~~~~~~~~~~~~~~~~~~~"
# Check login with whoami
echo "Invoking NPM whoami"
echo "~~~~~~~~~~~~~~~~~~~~~~"
npm --registry http://npm.sencha.com/ whoami
echo "~~~~~~~~~~~~~~~~~~~~~~"
Here's a Travis CI example configuration.
env:
# npm.sencha.com
# gem install travis
# travis login --pro --github-token replace_with_github_personal_token
# cd to/repo
# travis encrypt SENCHA_NPM_TOKEN_VERDACCIO="replace_with_apikey"
# SENCHA_NPM_TOKEN_VERDACCIO - secure: "XXXX... generation removed"
# early-adopter
# travis encrypt SENCHA_NPM_TOKEN_EARLYADOPTER="replace_with_apikey"
- secure: "XXXX... generation removed"
os: osx
language: node_js
node_js:
- "lts/*"
cache:
npm: false
before_install:
# NPM Login - commercial
# - npm config set @sencha:registry https://npm.sencha.com/
# - npm config set //npm.sencha.com/:_authToken=$SENCHA_NPM_TOKEN_VERDACCIO
# NPM Login - early-adopter
- npm config set @sencha:registry https://sencha.myget.org/F/early-adopter/npm/
- npm config set //sencha.myget.org/F/early-adopter/npm/:_authToken=$SENCHA_NPM_TOKEN_EARLYADOPTER
install:
- cd internal-components
- npm install
script:
- npm run build
deploy:
skip_cleanup: true
provider: script
script: bash deploy.sh
on:
branch: master
# Run CLI in this repo
# Delete Cache
# travis cache
# travis cache --delete
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.
Sometimes, especially for continuous integration, you may desire a scenario where you do not want to worry about access credentials or authentication to obtain content from our NPM repository.
This section outlines the way in which you can download all the Sencha node packages from our repo, saving them locally, without the need for constant authentication.
In this guide, we will use a target local directory of ‘./vendor’ to contain all the Sencha node packages. This can be named anything of meaning to you. The following steps assume you are in your application’s root directory.
1. Login to Sencha’s NPM repository to authenticate yourself so you may access all Sencha packages.
> npm set @sencha:registry=https://npm.sencha.com
> npm login --registry=https://npm.sencha.com --scope=@sencha
2. While authenticated, install all Sencha packages required by your application except @sencha/ext-webpack-plugin.
3. After all packages are installed, copy the contents of ./node_modules/@sencha to ./vendor/@sencha. Ensure that any source control application you use has the ‘./vendor’ directory added to it so that these packages are available in any target system that will checkout your application.
4. Update your package.json to link all required packages to their new location in the ./vendor folder. For example:
“dependencies”: {
“@sencha/ext”: “file:vendor/@sencha/ext”
}
5. Next, update the package.json file for each individual Sencha package found in the ‘vendor’ directory (e.g. vendor/@sencha/ext/package.json). You will want to
a. Remove any/all “scripts” definitions in the file. For example:
“scripts”: {
“install”: “node authorize.js”
}
b. Update dependency references to reflect that other packages are now locally found in the vendor folder. For example:
“@dependencies”: {
“@sencha/ext-core”: “file:../ext-core”
}
c. Finally, remove any “_activatedby” property which may exist in the package.json (it should be located at the bottom). These properties are part of npm authentication and may cause issues if retained.
6. As you will no longer be using Sencha NPM server, unregister the packages locally from the server by editing your .npmrc file and commenting out the following line (if present) by placing a hash symbol at the start:
# @sencha:registry = “https://npm.sencha.com”
7. Delete your ./node modules directory along with the package-lock.json file.
8. Edit package.json and remove ‘@sencha/ext-webpack-plugin’ from the “devDependencies” block (if one exists).
9. Run npm install to re-populate the node_modules required for your application. This will also populate the ‘node_modules/@sencha’ directory with links to your vendor directory locations, rather than downloading the source from our repository.
10. Run npm install @sencha/ext-webpack-plugin --save-dev. NPM will install this package and its @sencha/cmd dependency from the public npm registry.
11. If you previously have a build server configured with any Sencha authentication, you may remove this authentication from any buildspec files. As you will be using your own local copy of our packages, Sencha npm repo authentication is no longer necessary.
12. Finally, commit these changes to any CVS and review CI/CD pipelines as necessary to ensure builds run correctly and without incident.
Please refer to the following GIFs to see the process.
Demo 1:
Demo 2:
For troubleshooting your authentication to Sencha's repositories, refer to Npm Troubleshooting
Ext JS | Terms of Use