ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

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.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

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

Or in the case of an ExtReact component class this indicates a member of type prop

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

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

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.

ExtReact 6.5.0


top

Getting Started with ExtReact

Overview

This guide will show you how to install and configure ExtReact in your development environment.

Requirements

ExtReact requires the following to be installed before proceeding:

* Java requirement only applies to Linux. Java is automatically bundled with ExtReact's Webpack plugin on Windows and Mac OS if Java is not installed)

Creating Your First ExtReact Application

Step 1: Authenticate to Sencha's NPM Registry

ExtReact and all related packages are hosted on Sencha's private NPM registry. To gain access to this registry, sign up for a trial of ExtReact.

Once you have received your credentials, you can authenticate by running the following command:

npm login --registry=http://npm.sencha.com --scope=@extjs

This command configures npm to download packages in the @extjs scope from Sencha's registry.

Step 2: Create a New Application

If you are new to React, or do not have an existing application, we recommend using Yeoman to create a new ExtReact app:

npm install -g yo @extjs/generator-ext-react
yo @extjs/ext-react

The Yeoman generator will ask if you'd like to include some example code in your app. If this is your first time using ExtReact, we suggest to you include the example code so that you can see how some of the more common components work.

If you prefer to use create-react-app, see Adding ExtReact to Apps Built With create-react-app.

Step 3: Run Your New Application

Once the app has been created, run the following to start the app and open it in a browser:

cd your-app-name-here
npm start

The commands above are displayed as the last lines of output from Yeoman for your convenience.

The resulting app uses webpack-dev-server and react-hot-loader. Any changes you make will be immediately reflected in the browser.

Adding ExtReact to an Existing Application

If you use create-react-app, see Adding ExtReact to Apps Using create-react-app.

Otherwise, see Adding ExtReact to an Existing React Application.

Example Applications

The extjs-reactor repo on GitHub contains several example apps that you can use to learn more about ExtReact. Each has a readme that contains instructions for downloading and running:

Appendix

Installing Node and NPM

You can check the version of node you have installed by running:

node --version

To install node on Mac OS and Linux, we recommend using nvm. If you already have nvm installed, you can install the latest stable version of Node and NPM using:

 nvm install stable

On Windows you can use the official installer. There is also a version of nvm for Windows

Installing Java

In order to install ExtReact's webpack plugin on Linux, Java 7+ must first be installed.

You can check which version of Java you have installed by running:

java -version

On Debian-based platforms, you can install OpenJDK using:

sudo apt-get install openjdk-8-jdk

... or you can install Oracle's JDK using:

sudo add-apt-repository ppa:webupd8team/java -y
sudo apt-get update
sudo apt-get install oracle-java8-installer

ExtReact 6.5.0