ExtReact Docs Help


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

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.


item :  Object

The config object being added.


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.

ExtAngular 6.7.0


Adding ExtAngular to an Existing Angular Application

The guides provides the steps necessary to add ExtAngular to an existing Angular application.


ExtAngular requires the following:

  • Node 8.11+
  • NPM 6+
  • Angular 7+
  • Webpack 4+

Installing ExtAngular Packages from NPM

Note: you must be signed into the Sencha NPM registry to access the ExtAngular packages. See Authenticating to Sencha's NPM Registry for more information.

Run the following commands to install ExtAngular and its dependencies:

npm install --save @sencha/ext-angular
npm install --save @sencha/ext @sencha/ext-modern @sencha/ext-modern-theme-material
npm install --save-dev @sencha/ext-angular-webpack-plugin html-webpack-plugin webpack-filter-warnings-plugin
npm install --save webpack webpack-cli webpack-dev-server
npm install --save  css-loader file-loader html-loader node-sass raw-loader sass-loader style-loader
npm install --save @ngtools/webpack

ExtAngular also provides a number of optional packages listed here

Configuring Webpack

ExtAngular requires a webpack plugin to bundle and optimize the ExtAngular components you use in your application. Add it to your webpack config as follows:

// import the plugins
const AngularCompilerPlugin = require('@ngtools/webpack').AngularCompilerPlugin
const ExtWebpackPlugin = require('@sencha/ext-angular-webpack-plugin')
const path = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')
const webpack = require("webpack")
const FilterWarningsPlugin = require('webpack-filter-warnings-plugin')

// define the plugins
const plugins = [
  new AngularCompilerPlugin({
    tsConfigPath: './tsconfig.json',
    mainPath: "./src/main.ts",
    skipCodeGeneration: true
  new HtmlWebpackPlugin({
    template: "index.html",
    inject: "body"
  new ExtWebpackPlugin({
    framework: 'angular',
    port: port
  new webpack.ContextReplacementPlugin(
      path.resolve(__dirname, 'src'),{}
  new FilterWarningsPlugin({
      exclude: /System.import/

// then, in your webpack config options:
return {
  entry: {
    polyfills: "./polyfills.ts",
    main: "./main.ts"
  context: path.join(__dirname, './src'),
  output: {
    path: path.resolve(__dirname, 'build'),
    filename: "[name].js"
  module: {
    rules: [
      {test: /\.(png|svg|jpg|jpeg|gif)$/, use: ['file-loader']},
      {test: /\.css$/, loader: ["style-loader", "css-loader"]},
      {test: /\.ts$/,  loader: '@ngtools/webpack'},
      {test: /\.html$/,loader: "html-loader"},
  node: false,
  devtool: "source-map",
  devServer: {
    contentBase: './build',
    historyApiFallback: true,
    hot: false,
    host: '',
    port: port,
    disableHostCheck: false,
    compress: true,
    inline: false,
    stats: {
      assets: false,
      children: false,
      chunks: false,
      hash: false,
      modules: false,
      publicPath: false,
      timings: false,
      version: false,
      warnings: false,
      colors: {
        green: '\u001b[32m'

Note: If you're using html-webpack-plugin, make sure it comes before ExtWebpackPlugin in the plugins array so that tags for ext.js and ext.css are included in the resulting index.html.

For more information on configuring the ExtWebpackPlugin for Angular, see Building with Webpack.

You can also use the webpack configuration file in the ExtAngular Boilerplate for reference

Updating index.html

If you're using html-webpack-plugin, the JavaScript and CSS resources generated by ExtWebpackPlugin for angular will automatically be added to your index.html file at build time. If not, you'll need to add them manually:

<!doctype html>
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
    <link href="build/ext-angular/ext.css" rel="stylesheet">
    <script type="text/javascript" src="build/ext-angular/ext.js"></script>

HTML Doctype

The HTML5 doctype declaration is required for ExtAngular components to display properly. Please make sure that this declaration is present at the top of your HTML document:

<!doctype html>

Viewport Meta Tag

ExtAngular requires a viewport meta tag. This should be added to the <head> element in your index.html.

<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">

Launching your Application

To launch your app, add the following to your main.ts file (your webpack entry point):

import { bootstrapModule } from '@sencha/ext-angular/esm5/lib/ext-angular-bootstrap.component';
import {AppModule} from './app/app.module';


Here AppModule is your applications root module. You would need a bootstrap component and a bootstrap service to successfully launch your application with the created folder. You can use these in your applications root module to launch your application as follows:

//declare Ext
declare var Ext: any

//Import Ext Angular module and dependency files
import { ExtAngularModule } from '@sencha/ext-angular'
import { ExtAngularBootstrapService } from '@sencha/ext-angular/esm5/lib/ext-angular-bootstrap.service'
import { ExtAngularBootstrapComponent } from '@sencha/ext-angular/esm5/lib/ext-angular-bootstrap.component'

//define your root module
  imports:         [ ExtAngularModule],
  declarations:    [ExtAngularBootstrapComponent, AppComponent],
  providers:       [ExtAngularBootstrapService],
  entryComponents: [AppComponent],
  bootstrap:       [ExtAngularBootstrapComponent]
export class AppModule {
  constructor(extAngularService : ExtAngularBootstrapService) {

Make sure

  1. ExtAngularBootstrapComponent is imported and added in declarations and bootstrap entries.
  2. ExtAngularBootstrapService is imported and added in providers entry.
  3. You inject ExtAngularBootstrapService service in AppModule constructor and call extAngularService.setBootStrapComponent(AppComponent) where AppComponent is your entry component.


If you're using ESLint, add Ext as an allowed global:

"globals": {
    "Ext": true

Help Me, I'm Stuck!

We realize that Angular apps and build configurations vary greatly from project to project. If you get stuck, come ask for help in the ExtAngular Q&A Forum.

ExtAngular 6.7.0