ExtReact Docs Help

Contents

Introduction Terms, Icons, and Labels Access Levels Member Types Member Syntax Member Flags Class Icons Member Icons Navigation and Features Class Member Quick-Nav Menu Getter and Setter Methods History Bar Search and Filters API Doc Class Metadata Expanding and Collapsing Examples and Class Members Desktop -vs- Mobile View Viewing the Class Source

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

Ext.container.Container
view source
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.7.0


top

Contents

Requirements Installing ExtReact Packages from NPM Configuring Webpack Configuring Babel Updating index.html HTML Doctype Viewport Meta Tag Launching your Application renderWhenReady(Component) React Hot Loader The config ESLint Help Me, I'm Stuck!

Adding ExtReact to an Existing React Application

The guides provides the steps necessary to add ExtReact to an existing React application.

Requirements

ExtReact requires the following:

  • Node 8.11+
  • NPM 6+
  • React 16.5
  • Webpack 4+
  • Babel 7+
  • Java 8 *

Installing ExtReact Packages from NPM

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

Run the following commands to install ExtReact and its dependencies:

npm install --save @sencha/ext-react
npm install --save @sencha/ext @sencha/ext-modern @sencha/ext-modern-theme-material
npm install --save-dev @sencha/ext-react-webpack-plugin @sencha/ext-react-babel-plugin html-webpack-plugin

ExtReact also provides a number of optional packages listed here

Configuring Webpack

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

// import the plugins
const HtmlWebpackPlugin = require('html-webpack-plugin')
const ExtReactWebpackPlugin = require('@sencha/ext-react-webpack-plugin');
...

// then, in your webpack config options:
return {
  plugins: [
    new HtmlWebpackPlugin({
      template: 'index.html',
      hash: true
    }), 
    new ExtReactWebpackPlugin({
      port:port,
    }) 
  ]
}

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

If using webpack-dev-server, make sure that the build directory is in the contentBase config. 

contentBase: "./build"

If contentBase is set to another directory, you can change the value to an array and add "build":

contentBase: ["static", "./build"]

For more information on configuring the ExtReactWebpackPlugin, see Building with Webpack.

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

Configuring Babel

In order to build your application, @sencha/ext-react-babel-plugin must be included in your babel configuration and ES6 module transpilation must be turned off. Here is an example .babelrc:

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "modules": false
      }
    ],
    "@babel/preset-react"
  ],
  "plugins": [
    "react-hot-loader/babel",
    "@sencha/ext-react-babel-plugin",
    "@babel/plugin-transform-runtime",
    "@babel/plugin-syntax-dynamic-import",
    "@babel/plugin-syntax-import-meta",
    "@babel/plugin-proposal-class-properties",
    "@babel/plugin-proposal-json-strings",
    [
      "@babel/plugin-proposal-decorators",
      {
        "legacy": true
      }
    ],
    "@babel/plugin-proposal-function-sent",
    "@babel/plugin-proposal-export-namespace-from",
    "@babel/plugin-proposal-numeric-separator",
    "@babel/plugin-proposal-throw-expressions"
  ],
  "ignore": [
    "build"
  ],
  "env": {
    "test": {
      "presets": [
        "@babel/preset-env",
        "@babel/preset-react"
      ],
      "plugins": [
        "@babel/plugin-syntax-dynamic-import",
        "@babel/plugin-syntax-import-meta",
        "@babel/plugin-proposal-class-properties",
        "@babel/plugin-proposal-json-strings",
        [
          "@babel/plugin-proposal-decorators",
          {
            "legacy": true
          }
        ],
        "@babel/plugin-proposal-function-sent",
        "@babel/plugin-proposal-export-namespace-from",
        "@babel/plugin-proposal-numeric-separator",
        "@babel/plugin-proposal-throw-expressions"
      ]
    }
  }
}

Note: disabling ES6 module transpilation in babel doesn't prevent you from using import statements. It just defers the processing of those statements to Webpack, which enables tree-shaking and will help descrease the size of your application bundle.

Updating index.html

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

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

HTML Doctype

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

<!doctype html>

Viewport Meta Tag

ExtReact 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

The @sencha/ext-react package provides a launch function to using instead of ReactDOM.render():

launch(React.Element/Function)

To launch your app, add the following to your index.js file (your webpack entry point): When using with React v16 and above, developers need to add a new component called ExtReact at the root before using Ext JS component. Best way is to add it at the application’s entry point or launch method and then ExtJS Component can be used anywhere throughout application.

import { launch } from '@sencha/ext-react';
import { ExtReact } from '@sencha/ext-react'

import App from './App';

launch(<ExtReact><App/><ExtReact>);

The launch function renders the specified component into the document body. It also accepts a callback function that returns the component to be rendered:

launch(() => {
  // do some initialization before initial render
  // ...

  // return the component to be rendered
  return <App/>;
})

The launch function serves two purposes:

  1. It delays your App's initial render until the ExtReact class system is fully initialized
  2. It creates a viewport, which is needed for creating components that take up the full height and width of the screen.

When using launch you do not need a separate target <div id="root"/> in your index.html file. If you have one you should remove it. The code above replaces the typical code for launching a React app, which generally looks something like:

import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App/>, document.getElementById('root'));

renderWhenReady(Component)

If you do not need to create fullscreen components (for example if you're using ExtReact components with another layout system), you can apply the renderWhenReady higher-order component to topmost component containing an ExtReact element, omit the launch function, and render to a target element as is customary with React. This is especially useful if you're building a library of components based on ExtReact and you don't want to require the applications that use your library to call launch.

// App.js
import React, { Component } from 'react';
import { Panel } from '@sencha/ext-modern';
import { renderWhenReady } from '@sencha/ext-react';

class App extends Component {
    render() {
        return (
            <Panel title="ExtReact">Hello World!</Panel>
        )
    }
}

export default renderWhenReady(App);

// index.js
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App/>, document.getElementById('root'));

React Hot Loader

Here is an example that uses the launch function's callback parameter to enable react-hot-loader. The callback is passed a DOM element that can be used as the target when calling ReactDOM.render.

import React from 'react'
import ReactDOM from 'react-dom'
import { AppContainer } from 'react-hot-loader'
import { launch } from '@sencha/ext-react';
import { ExtReact } from '@sencha/ext-react'
import App from './App'

let viewport;

const render = (Component, target) => {
    ReactDOM.render(
        <ExtReact>
            <AppContainer>
                <Component/>
            </AppContainer>
        </ExtReact>,
        target
    )
}

launch(target => render(App, viewport = target));

if (module.hot) {
    module.hot.accept('./App', () => render(App, viewport));
}

The fullscreen config

Most apps that use ExtReact are single-page applications that occupy the full height and width of the browser window. To acheive this, the root ExtReact component in your app should be configured with the fullscreen prop set to true. For example:

import { Container } from '@sencha/ext-modern';

export default function App() {
  return (
    <Container fullscreen>
      ...
    </Container>
  )
}

ESLint

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

"globals": {
    "Ext": true
}

Help Me, I'm Stuck!

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

ExtReact 6.7.0