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 7.0.0


top

Developing for Multiple Environments and Screens

ExtReact helps developers provide a great user experience across all devices and screen sizes. This guide explains how you can implement responsive and adaptive designs using ExtReact to create the right ui for every environment.

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

Flexible Layouts

ExtReact provides the following layouts that automatically adjust the size of child elements based on the available space:

  • fit - Sizes a single child element so that it fills 100% of the height and width of the parent.
  • box - Children are sized proportionally based on the relative values of their flex props.
  • hbox - A subclass of box layout with horizontal alignment.
  • vbox - A subclass of box layout with vertical alignment.

For example, to divide the available horizontal space between two components evenly:

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

function App() {
  return (
    <Container layout="hbox">
      <Panel title="Left" flex={1}>...</Panel>
      <Panel title="Right" flex={1}>...</Panel>
    </Container>
  )
}

You can also fix the size of some children while allowing the others to fill the remaining space:

<Container layout="hbox">
  <Panel title="Left" width={300}>...</Panel>
  <Panel title="Right" flex={1}>...</Panel>
</Container>

Or, allow a child to grow or shrink to a specific size and no further:

<Container layout="hbox">
  <Panel title="Left" maxWidth={500} flex={1}>...</Panel>
  <Panel title="Right" flex={1}>...</Panel>
</Container>

Use relative flex values to designate a proportional amount of space for each child. For example, to give 1/3 of the horizontal space to the left panel and 2/3 to the right panel:

<Container layout="hbox">
  <Panel title="Left" flex={1}>...</Panel>
  <Panel title="Right" flex={2}>...</Panel>
</Container>

Platform Queries

ExtReact lets you adapt your UI to the user's device type and platform:

Ext.platformTags

You can use Ext.platformTags to check the platform on which your app is running. Here is an example that displays separate UI components when running on phones:

function App(props) {
  if (Ext.platformTags.phone) {
    return <PhoneUI/>
  } else {
    return <DesktopUI/>
  }
}

You can also check for specific browsers, for example: Ext.platformTags.safari, or operating systems: Ext.platformTags.android.

To check for a specific os version, use Ext.os.version.

The platformConfig prop

You can specify different props for different environments using the platformConfig prop. Here is an example that uses a vertical layout on a phone and a horizontal layout on all other environments:

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

function App() {
  return (
    <Container 
      layout="hbox"
      platformConfig={{
        "phone": {
          layout: 'vbox'
        }
      }}
    >
      ...
    </Container>
  )
}

You can use negation ("!") to target all environments except a specific one. The Container in the example above could also be written as:

<Container 
  layout="vbox"
  platformConfig={{
    "!phone": {
      layout: 'hbox'
    }
  }}
>
  ...
</Container>

or

<Container 
  platformConfig={{
    "phone": {
      layout: 'vbox'
    },
    "!phone": {
      layout: 'hbox'
    }
  }}
>
  ...
</Container>

or, using Ext.platformTags:

<Container layout={Ext.platformTags.phone ? 'vbox' : 'hbox'}>
  ...
</Container>

Responsive Props

You can provide different props based on screen size using the responsiveConfig prop. When using responsiveConfig, the UI is automatically updated when the user rotates or resizes the browser window.

For example, to abbreviate the title of a panel when the screen is less than 600 pixels wide:

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

function App() {
  return (
    <Panel 
      responsiveConfig={{
        'width >= 600': {
          title: 'Manufacturing Summary'
        },
        'width < 600': {
          title: 'Mfg Summary'
        }
      }}
    >
      ...
    </Panel>
  )
}

To make use of the responsiveConfig prop, make sure it is required somewhere in your app with Ext.require:

// App.js

Ext.require('Ext.plugin.Responsive');

You can also set different props for landscape and portrait. Here is an example that abbreviates the panel title when the device is in portrait orientation.

<Container 
  responsiveConfig={{
    landscape: {
      title: 'Manufacturing Summary'
    },
    portrait: {
      title: 'Mfg Summary'
    }
  }}
>
    ...
</Container>

The responsiveConfig prop also accepts platformTags. For example:

<Container 
  platformConfig={{
    "phone": {
      layout: 'vbox'
    },
    "!phone": {
      layout: 'hbox'
    }
  }}
>
    ...
</Container>

You can share responsive formulas between all of your components by defining them in a separate module:

// responsiveFormulas.js
export const xsmall = "width <= 576";
export const small = "width <= 768";
export const medium = "width <= 992";
export const large = "width <= 1200";
export const xlarge = "width > 1200";

And importing them into your responsive components:

// MyComponent.js
import { small, xsmall } from './responsiveFormulas';

export default function MyComponent(props) {
  return (
    <Panel 
      responsiveConfig={{
        true: {
          title: 'Summary of Manufacturing'
        }
        [small]: {
          title: 'Manufacturing Summary'
        },
        [xsmall]: {
          title: 'Mfg Summary'
        }
      }}
    >
      ...
    </Panel>
  )
}

Here we use a value of true for the first key to provide a default title.

You can also define your own custom formulas as functions. For example, we can define a responsive formula for weekend days:

// responsiveFormulas.js
...
export const weekends = (context) => {
  const today = new Date().getDay();
  return today === 0 || today === 6
}

When defining your own responsive formula functions, import them as an object and assign them to the component's responsiveFormulas prop. Then refer to each formula by name in the responsiveConfig prop:

// MyComponent.js
import * as responsiveFormulas from './responsiveFormulas';

export default function MyComponent(props) {
  return (
    <Panel 
      responsiveFormulas={responsiveFormulas}
      responsiveConfig={{
        true: {
          title: 'Summary of Manufacturing'
        }
        small: {
          title: 'Manufacturing Summary'
        },
        weekends: {
          title: "Go home, it's a weekend!"
        }
      }}
    >
      ...
    </Panel>
  )
}

The responsiveConfig prop is provided by the responsive plugin, which is automatically added to any ExtReact component with a responsiveConfig prop.

ExtReact 7.0.0