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


top

Ext.mixin.Responsive

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.Mixin
Ext.mixin.Responsive

Sub-Classes

Ext.plugin.Responsive

Mixed Into

Ext.Responsive

Summary

This mixin provides its user with a responsiveConfig config that allows the class to conditionally control config properties.

For example:

 Ext.define('ResponsiveClass', {
     mixin: [
         'Ext.mixin.Responsive'
     ],

     responsiveConfig: {
         portrait: {
         },

         landscape: {
         }
     }
 });

For a config to participate as a responsiveConfig it must have a "setter" method. In the below example, a "setRegion" method must exist.

 Ext.create({
     xtype: 'viewport',
     layout: 'border',

     items: [{
         title: 'Some Title',
         plugins: 'responsive',

         responsiveConfig: {
             'width < 800': {
                 region: 'north'
             },
             'width >= 800': {
                 region: 'west'
             }
         }
     }]
 });

To use responsiveConfig the class must be defined using the Ext.mixin.Responsive mixin.

 Ext.define('App.view.Foo', {
     extend: 'Ext.panel.Panel',
     xtype: 'foo',
     mixins: [
          'Ext.mixin.Responsive'
     ],
     ...
 });

Otherwise, you will need to use the responsive plugin if the class is not one you authored.

 Ext.create('Ext.panel.Panel', {
     renderTo: document.body,
     plugins: 'responsive',
     ...
 });

Note: There is the exception of Ext.container.Viewport or other classes using Ext.plugin.Viewport. In those cases, the viewport plugin inherits from Ext.plugin.Responsive.

For details see responsiveConfig.

No members found using the current filters

configs

Optional Configs

responsiveConfig : Object

This object consists of keys that represent the conditions on which configs will be applied. For example:

 responsiveConfig: {
     landscape: {
         region: 'west'
     },
     portrait: {
         region: 'north'
     }
 }

In this case the keys ("landscape" and "portrait") are the criteria (or "rules") and the object to their right contains the configs that will apply when that rule is true.

These rules can be any valid JavaScript expression but the following values are considered in scope:

  • landscape - True if the device orientation is landscape (always true on desktop devices).
  • portrait - True if the device orientation is portrait (always false on desktop devices).
  • tall - True if width < height regardless of device type.
  • wide - True if width > height regardless of device type.
  • width - The width of the viewport in pixels.
  • height - The height of the viewport in pixels.
  • platform - An object containing various booleans describing the platform (see Ext.platformTags). The properties of this object are also available implicitly (without "platform." prefix) but this sub-object may be useful to resolve ambiguity (for example, if one of the responsiveFormulas overlaps and hides any of these properties). Previous to Ext JS 5.1, the platformTags were only available using this prefix.

A more complex example:

 responsiveConfig: {
     'desktop || width > 800': {
         region: 'west'
     },

     '!(desktop || width > 800)': {
         region: 'north'
     }
 }

NOTE: If multiple rules set a single config (like above), it is important that the rules be mutually exclusive. That is, only one rule should set each config. If multiple rules are actively setting a single config, the order of these (and therefore the config's value) is unspecified.

For a config to participate as a responsiveConfig it must have a "setter" method. In the above example, a "setRegion" method must exist.

Defaults to:

undefined

Available since: 5.0.0

getResponsiveConfig : Object

Returns the value of responsiveConfig

Returns

Object

setResponsiveConfig (responsiveConfig)

Sets the value of responsiveConfig

Parameters

responsiveConfig :  Object

responsiveConfig : Object

This object consists of keys that represent the conditions on which configs will be applied. For example:

 responsiveConfig: {
     landscape: {
         region: 'west'
     },
     portrait: {
         region: 'north'
     }
 }

In this case the keys ("landscape" and "portrait") are the criteria (or "rules") and the object to their right contains the configs that will apply when that rule is true.

These rules can be any valid JavaScript expression but the following values are considered in scope:

  • landscape - True if the device orientation is landscape (always true on desktop devices).
  • portrait - True if the device orientation is portrait (always false on desktop devices).
  • tall - True if width < height regardless of device type.
  • wide - True if width > height regardless of device type.
  • width - The width of the viewport in pixels.
  • height - The height of the viewport in pixels.
  • platform - An object containing various booleans describing the platform (see Ext.platformTags). The properties of this object are also available implicitly (without "platform." prefix) but this sub-object may be useful to resolve ambiguity (for example, if one of the responsiveFormulas overlaps and hides any of these properties). Previous to Ext JS 5.1, the platformTags were only available using this prefix.

A more complex example:

 responsiveConfig: {
     'desktop || width > 800': {
         region: 'west'
     },

     '!(desktop || width > 800)': {
         region: 'north'
     }
 }

NOTE: If multiple rules set a single config (like above), it is important that the rules be mutually exclusive. That is, only one rule should set each config. If multiple rules are actively setting a single config, the order of these (and therefore the config's value) is unspecified.

For a config to participate as a responsiveConfig it must have a "setter" method. In the above example, a "setRegion" method must exist.

Available since: 5.0.0

getResponsiveConfig : Object

Returns the value of responsiveConfig

Returns

Object

setResponsiveConfig (responsiveConfig)

Sets the value of responsiveConfig

Parameters

responsiveConfig :  Object

responsiveFormulas : Object

It is common when using responsiveConfig to have recurring expressions that make for complex configurations. Using responsiveFormulas allows you to cut down on this repetition by adding new properties to the "scope" for the rules in a responsiveConfig.

For example:

 Ext.define('MyApp.view.main.Main', {
     extend: 'Ext.container.Container',

     mixins: [
         'Ext.mixin.Responsive'
     ],

     responsiveFormulas: {
         small: 'width < 600',

         medium: 'width >= 600 && width < 800',

         large: 'width >= 800',

         tuesday: function(context) {
             return (new Date()).getDay() === 2;
         }
     }
 });

With the above declaration, any responsiveConfig can now use these values like so:

 responsiveConfig: {
     small: {
         hidden: true
     },
     'medium && !tuesday': {
         hidden: false,
         region: 'north'
     },
     large: {
         hidden: false,
         region: 'west'
     }
 }

Defaults to:

null

Available since: 5.0.1

getResponsiveFormulas : Object

Returns the value of responsiveFormulas

Returns

Object

setResponsiveFormulas (responsiveFormulas)

Sets the value of responsiveFormulas

Parameters

responsiveFormulas :  Object

responsiveFormulas : Object

It is common when using responsiveConfig to have recurring expressions that make for complex configurations. Using responsiveFormulas allows you to cut down on this repetition by adding new properties to the "scope" for the rules in a responsiveConfig.

For example:

 Ext.define('MyApp.view.main.Main', {
     extend: 'Ext.container.Container',

     mixins: [
         'Ext.mixin.Responsive'
     ],

     responsiveFormulas: {
         small: 'width < 600',

         medium: 'width >= 600 && width < 800',

         large: 'width >= 800',

         tuesday: function (context) {
             return (new Date()).getDay() === 2;
         }
     }
 });

With the above declaration, any responsiveConfig can now use these values like so:

 responsiveConfig: {
     small: {
         hidden: true
     },
     'medium && !tuesday': {
         hidden: false,
         region: 'north'
     },
     large: {
         hidden: false,
         region: 'west'
     }
 }

Available since: 5.0.1

getResponsiveFormulas : Object

Returns the value of responsiveFormulas

Returns

Object

setResponsiveFormulas (responsiveFormulas)

Sets the value of responsiveFormulas

Parameters

responsiveFormulas :  Object

properties

Static Properties

active : Boolean
static sta private pri

Defaults to:

false

all : Object
static sta private pri

The collection of all Responsive instances. These are the instances that will be notified when dynamic conditions change.

Defaults to:

{}

context : Object
static sta private pri

This object holds the various context values passed to the rule evaluation functions.

Defaults to:

Ext.Object.chain(Ext.platformTags)

count : Number
static sta private pri

The number of instances in the all collection.

Defaults to:

0

nextId : Number
static sta private pri

The seed value used to assign Responsive instances a unique id for keying in the all collection.

Defaults to:

0

methods

Instance Methods

afterClassMixedIn ( targetClass )
private pri

This class system hook method is called at the tail end of the mixin process. We need to see if the targetClass has already got a responsiveConfig and if so, we must add its value to the real config.

Parameters

targetClass :  Ext.Class

destroy

This method removes this instance from the Responsive collection.

destroy

This method removes this instance from the Responsive collection.

getResponsiveState
private pri

Evaluates and returns the configs based on the responsiveConfig. This method relies on the state being captured by the updateContext method.

transformResponsiveConfig ( instanceConfig, configurator )
private pri

This config system hook method is called just prior to processing the specified "instanceConfig". This hook returns the instanceConfig that will actually be processed by the config system.

Parameters

instanceConfig :  Object

The user-supplied instance config object.

configurator :  Ext.Configurator

updateResponsiveState
private pri

Evaluates and applies the responsiveConfig to this instance. This is called by notify automatically.

Static Methods

activate
static sta private pri

Activates event listeners for all Responsive instances. This method is called when the first instance is registered.

deactivate
static sta private pri

Deactivates event listeners. This method is called when the last instance is destroyed.

notify
static sta private pri

Updates all registered the Responsive instances (found in the all collection).

onResize
static sta private pri

Handler of the window resize event. Schedules a timer so that we eventually call notify.

onTimer
static sta private pri

This method is the timer handler. When called this removes the timer and calls notify.

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

updateContext
static sta private pri

Updates the context object base on the current environment.

ExtReact 6.7.0